{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/communication:baremetrics/account-get-details":{"get":{"operationId":"communication_baremetrics_account_get_details","summary":"Get Account","description":"GET /v1/account","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-list-sources":{"get":{"operationId":"communication_baremetrics_source_list_sources","summary":"List Sources","description":"GET /v1/sources","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-get-plans-list":{"get":{"operationId":"communication_baremetrics_source_get_plans_list","summary":"List Plans","description":"GET /v1/{source_id}/plans","tags":["communication"],"parameters":[{"name":"search","in":"query","required":false,"description":"Allows you to search based on the name or oid fields","schema":{"type":"string","description":"Allows you to search based on the name or oid fields"}},{"name":"source_id","in":"query","required":true,"description":"Please see [Sources](ref:sources)","schema":{"type":"string","description":"Please see [Sources](ref:sources)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-create-plan":{"post":{"operationId":"communication_baremetrics_source_create_plan","summary":"Create Plan","description":"POST /v1/{source_id}/plans","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["source_id"],"properties":{"source_id":{"type":"string","description":"Please see [Sources](ref:sources)"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-get-plan":{"get":{"operationId":"communication_baremetrics_source_get_plan","summary":"Show Plan","description":"GET /v1/{source_id}/plans/{oid}","tags":["communication"],"parameters":[{"name":"oid","in":"query","required":true,"schema":{"type":"string"}},{"name":"source_id","in":"query","required":true,"description":"Please see [Sources](ref:sources)","schema":{"type":"string","description":"Please see [Sources](ref:sources)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-delete-plan":{"post":{"operationId":"communication_baremetrics_source_delete_plan","summary":"Delete Plan","description":"DELETE /v1/{source_id}/plans/{oid}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["oid","source_id"],"properties":{"oid":{"type":"string"},"source_id":{"type":"string","description":"Please see [Sources](ref:sources)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-update-plan":{"post":{"operationId":"communication_baremetrics_source_update_plan","summary":"Update Plan","description":"PUT /v1/{source_id}/plans/{plan_oid}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["plan_oid","source_id"],"properties":{"plan_oid":{"type":"string","description":"Your interval plan id"},"source_id":{"type":"string","description":"Please see [Sources](ref:sources)"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-get-customer-list":{"get":{"operationId":"communication_baremetrics_source_get_customer_list","summary":"List Customers","description":"GET /v1/{source_id}/customers","tags":["communication"],"parameters":[{"name":"search","in":"query","required":false,"description":"Allows you to search for a customer based on: oid, email, notes and name","schema":{"type":"string","description":"Allows you to search for a customer based on: oid, email, notes and name"}},{"name":"source_id","in":"query","required":true,"description":"Please see [Sources](ref:sources)","schema":{"type":"string","description":"Please see [Sources](ref:sources)"}},{"name":"sort","in":"query","required":false,"description":"Allows you to sort the results. You can use ltv or created","schema":{"type":"string","default":"created","description":"Allows you to sort the results. You can use ltv or created"}},{"name":"order","in":"query","required":false,"schema":{"type":"string","default":"asc"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-create-customer-record":{"post":{"operationId":"communication_baremetrics_source_create_customer_record","summary":"Create Customer","description":"POST /v1/{source_id}/customers","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["source_id"],"properties":{"source_id":{"type":"string","description":"Please see [Sources](ref:sources)"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-get-customer-details":{"get":{"operationId":"communication_baremetrics_source_get_customer_details","summary":"Show Customer","description":"GET /v1/{source_id}/customers/{oid}","tags":["communication"],"parameters":[{"name":"oid","in":"query","required":true,"schema":{"type":"string"}},{"name":"source_id","in":"query","required":true,"description":"Please see [Sources](ref:sources)","schema":{"type":"string","description":"Please see [Sources](ref:sources)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-delete-customer":{"post":{"operationId":"communication_baremetrics_source_delete_customer","summary":"Delete Customer","description":"DELETE /v1/{source_id}/customers/{oid}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["oid","source_id"],"properties":{"oid":{"type":"string"},"source_id":{"type":"string","description":"Please see [Sources](ref:sources)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-list-customer-events":{"get":{"operationId":"communication_baremetrics_source_list_customer_events","summary":"List Customer Events","description":"GET /v1/{source_id}/customers/{oid}/events","tags":["communication"],"parameters":[{"name":"source_id","in":"query","required":true,"description":"Please see [Sources](ref:sources)","schema":{"type":"string","description":"Please see [Sources](ref:sources)"}},{"name":"oid","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-update-customer-information":{"post":{"operationId":"communication_baremetrics_source_update_customer_information","summary":"Update Customer","description":"PUT /v1/{source_id}/customers/{customer_oid}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customer_oid","source_id"],"properties":{"customer_oid":{"type":"string","description":"Your unique ID for the customer"},"source_id":{"type":"string","description":"Please see [Sources](ref:sources)"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-get-subscriptions":{"get":{"operationId":"communication_baremetrics_source_get_subscriptions","summary":"List Subscriptions","description":"GET /v1/{source_id}/subscriptions","tags":["communication"],"parameters":[{"name":"source_id","in":"query","required":true,"description":"Please see [Sources](ref:sources)","schema":{"type":"string","description":"Please see [Sources](ref:sources)"}},{"name":"customer_oid","in":"query","required":false,"description":"This allows you to return subscriptions for a given customer","schema":{"type":"string","description":"This allows you to return subscriptions for a given customer"}},{"name":"order","in":"query","required":false,"description":"Allows you to order subscriptions from newest to oldest `desc` or oldest to newest `asc`","schema":{"type":"string","default":"desc","description":"Allows you to order subscriptions from newest to oldest `desc` or oldest to newest `asc`"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-create-subscription":{"post":{"operationId":"communication_baremetrics_source_create_subscription","summary":"Create Subscription","description":"POST /v1/{source_id}/subscriptions","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["source_id"],"properties":{"source_id":{"type":"string","description":"Please see [Sources](ref:sources)"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-get-subscription":{"get":{"operationId":"communication_baremetrics_source_get_subscription","summary":"Show Subscription","description":"GET /v1/{source_id}/subscriptions/{oid}","tags":["communication"],"parameters":[{"name":"oid","in":"query","required":true,"schema":{"type":"string"}},{"name":"source_id","in":"query","required":true,"description":"Please see [Sources](ref:sources)","schema":{"type":"string","description":"Please see [Sources](ref:sources)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-remove-subscription":{"post":{"operationId":"communication_baremetrics_source_remove_subscription","summary":"Delete Subscription","description":"DELETE /v1/{source_id}/subscriptions/{oid}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["oid","source_id"],"properties":{"oid":{"type":"string"},"source_id":{"type":"string","description":"Please see [Sources](ref:sources)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-update-subscription":{"post":{"operationId":"communication_baremetrics_source_update_subscription","summary":"Update Subscription","description":"PUT /v1/{source_id}/subscriptions/{subscription_oid}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription_oid","source_id"],"properties":{"subscription_oid":{"type":"string","description":"Your unique ID for the subscription"},"source_id":{"type":"string","description":"Please see [Sources](ref:sources)"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-cancel-subscription":{"post":{"operationId":"communication_baremetrics_source_cancel_subscription","summary":"Cancel Subscription","description":"PUT /v1/{source_id}/subscriptions/{subscription_oid}/cancel","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription_oid","source_id"],"properties":{"subscription_oid":{"type":"string","description":"Your unique ID for the subscription"},"source_id":{"type":"string","description":"Please see [Sources](ref:sources)"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/annotation-list":{"get":{"operationId":"communication_baremetrics_annotation_list","summary":"List Annotations","description":"GET /v1/annotations","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/annotation-create-new":{"post":{"operationId":"communication_baremetrics_annotation_create_new","summary":"Create Annotation","description":"POST /v1/annotations","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/annotation-get-details":{"get":{"operationId":"communication_baremetrics_annotation_get_details","summary":"Show Annotation","description":"GET /v1/annotations/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/annotation-remove-by-id":{"post":{"operationId":"communication_baremetrics_annotation_remove_by_id","summary":"Delete Annotation","description":"DELETE /v1/annotations/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/goal-get-list":{"get":{"operationId":"communication_baremetrics_goal_get_list","summary":"List Goals","description":"GET /v1/goals","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/goal-create-new-goal":{"post":{"operationId":"communication_baremetrics_goal_create_new_goal","summary":"Create Goal","description":"POST /v1/goals","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/goal-get-by-id":{"get":{"operationId":"communication_baremetrics_goal_get_by_id","summary":"Show Goal","description":"GET /v1/goals/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Unique ID","schema":{"type":"string","description":"Unique ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/goal-remove":{"post":{"operationId":"communication_baremetrics_goal_remove","summary":"Delete Goal","description":"DELETE /v1/goals/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/user-list-users":{"get":{"operationId":"communication_baremetrics_user_list_users","summary":"List Users","description":"GET /v1/users","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/user-get-user-by-id":{"get":{"operationId":"communication_baremetrics_user_get_user_by_id","summary":"Show User","description":"GET /v1/users/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-get-charge-list":{"get":{"operationId":"communication_baremetrics_source_get_charge_list","summary":"List Charges","description":"GET /v1/{source_id}/charges","tags":["communication"],"parameters":[{"name":"source_id","in":"query","required":true,"description":"Please see [Sources](ref:sources)","schema":{"type":"string","description":"Please see [Sources](ref:sources)"}},{"name":"start","in":"query","required":false,"schema":{"type":"string"}},{"name":"end","in":"query","required":false,"schema":{"type":"string"}},{"name":"subscription_oid","in":"query","required":false,"schema":{"type":"string"}},{"name":"customer_oid","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-create-charge-one-off":{"post":{"operationId":"communication_baremetrics_source_create_charge_one_off","summary":"Create Charge","description":"POST /v1/{source_id}/charges","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["source_id"],"properties":{"source_id":{"type":"string","description":"Please see [Sources](ref:sources)"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-get-charge-details":{"get":{"operationId":"communication_baremetrics_source_get_charge_details","summary":"Show Charge","description":"GET /v1/{source_id}/charges/{oid}","tags":["communication"],"parameters":[{"name":"source_id","in":"query","required":true,"description":"Please see [Sources](ref:sources)","schema":{"type":"string","description":"Please see [Sources](ref:sources)"}},{"name":"oid","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-remove-one-off-charge":{"post":{"operationId":"communication_baremetrics_source_remove_one_off_charge","summary":"Delete Charge","description":"DELETE /v1/{source_id}/charges/{oid}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["source_id","oid"],"properties":{"source_id":{"type":"string","description":"Please see [Sources](ref:sources)"},"oid":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-get-refunds":{"get":{"operationId":"communication_baremetrics_source_get_refunds","summary":"List Refunds","description":"GET /v1/{source_id}/refunds","tags":["communication"],"parameters":[{"name":"source_id","in":"query","required":true,"description":"Please see [Sources](ref:sources)","schema":{"type":"string","description":"Please see [Sources](ref:sources)"}},{"name":"start","in":"query","required":false,"schema":{"type":"string"}},{"name":"end","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-create-one-off-refund":{"post":{"operationId":"communication_baremetrics_source_create_one_off_refund","summary":"Create Refund","description":"POST /v1/{source_id}/refunds","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["source_id"],"properties":{"source_id":{"type":"string","description":"Please see [Sources](ref:sources)"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-get-refund-details":{"get":{"operationId":"communication_baremetrics_source_get_refund_details","summary":"Show Refund","description":"GET /v1/{source_id}/refunds/{oid}","tags":["communication"],"parameters":[{"name":"source_id","in":"query","required":true,"description":"Please see [Sources](ref:sources)","schema":{"type":"string","description":"Please see [Sources](ref:sources)"}},{"name":"oid","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-remove-one-off-refund":{"post":{"operationId":"communication_baremetrics_source_remove_one_off_refund","summary":"Delete Refund","description":"DELETE /v1/{source_id}/refunds/{oid}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["source_id","oid"],"properties":{"source_id":{"type":"string","description":"Please see [Sources](ref:sources)"},"oid":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-get-events":{"get":{"operationId":"communication_baremetrics_source_get_events","summary":"List Events","description":"GET /v1/{source_id}/events","tags":["communication"],"parameters":[{"name":"source_id","in":"query","required":true,"description":"Please see [Sources](ref:sources)","schema":{"type":"string","description":"Please see [Sources](ref:sources)"}},{"name":"live_stream","in":"query","required":false,"description":"Set this to true to only return events that show up in the live stream","schema":{"type":"string","default":"false","description":"Set this to true to only return events that show up in the live stream"}},{"name":"start","in":"query","required":false,"schema":{"type":"string"}},{"name":"end","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/source-get-event-by-id":{"get":{"operationId":"communication_baremetrics_source_get_event_by_id","summary":"Show Event","description":"GET /v1/{source_id}/events/{id}","tags":["communication"],"parameters":[{"name":"source_id","in":"query","required":true,"description":"Please see [Sources](ref:sources)","schema":{"type":"string","description":"Please see [Sources](ref:sources)"}},{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/metric-show-summary":{"get":{"operationId":"communication_baremetrics_metric_show_summary","summary":"Show Summary","description":"GET /v1/metrics","tags":["communication"],"parameters":[{"name":"start_date","in":"query","required":true,"schema":{"type":"string","default":"2016-11-01"}},{"name":"end_date","in":"query","required":true,"schema":{"type":"string","default":"2016-11-26"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/metric-show-details":{"get":{"operationId":"communication_baremetrics_metric_show_details","summary":"Show Metric","description":"GET /v1/metrics/{metric}","tags":["communication"],"parameters":[{"name":"metric","in":"query","required":true,"description":"You can see a list of available metrics [here](https://developers.baremetrics.com/reference/introduction)","schema":{"type":"string","description":"You can see a list of available metrics [here](https://developers.baremetrics.com/reference/introduction)"}},{"name":"start_date","in":"query","required":true,"schema":{"type":"string","default":"2016-11-01"}},{"name":"end_date","in":"query","required":true,"schema":{"type":"string","default":"2016-11-26"}},{"name":"compare_to","in":"query","required":false,"description":"The number of days ago to compare results to","schema":{"type":"integer","default":30,"description":"The number of days ago to compare results to"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/metric-list-customers":{"get":{"operationId":"communication_baremetrics_metric_list_customers","summary":"Show Customers","description":"GET /v1/metrics/{metric}/customers","tags":["communication"],"parameters":[{"name":"start_date","in":"query","required":true,"schema":{"type":"string"}},{"name":"end_date","in":"query","required":true,"schema":{"type":"string"}},{"name":"metric","in":"query","required":true,"description":"You can see a list of available metrics [here](https://developers.baremetrics.com/reference/introduction)","schema":{"type":"string","description":"You can see a list of available metrics [here](https://developers.baremetrics.com/reference/introduction)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/metric-show-plan-breakout":{"get":{"operationId":"communication_baremetrics_metric_show_plan_breakout","summary":"Show Plan Breakout","description":"GET /v1/metrics/{metric}/plans","tags":["communication"],"parameters":[{"name":"start_date","in":"query","required":true,"schema":{"type":"string"}},{"name":"end_date","in":"query","required":true,"schema":{"type":"string"}},{"name":"metric","in":"query","required":true,"description":"You can see a list of available metrics [here](https://developers.baremetrics.com/reference/introduction)","schema":{"type":"string","description":"You can see a list of available metrics [here](https://developers.baremetrics.com/reference/introduction)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/metric-show-cohorts":{"get":{"operationId":"communication_baremetrics_metric_show_cohorts","summary":"Show Cohorts","description":"GET /v1/metrics/cohorts","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/segment-get-fields":{"get":{"operationId":"communication_baremetrics_segment_get_fields","summary":"List Fields","description":"GET /v1/segments/fields","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/segment-list-segments":{"get":{"operationId":"communication_baremetrics_segment_list_segments","summary":"List Segments","description":"GET /v1/segments","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/segment-create-request":{"post":{"operationId":"communication_baremetrics_segment_create_request","summary":"Create Segment","description":"POST /v1/segments","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/segment-show-details":{"get":{"operationId":"communication_baremetrics_segment_show_details","summary":"Show Segment","description":"GET /v1/segments/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/segment-update-by-id":{"post":{"operationId":"communication_baremetrics_segment_update_by_id","summary":"Update Segment","description":"PUT /v1/segments/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/segment-remove-by-id":{"post":{"operationId":"communication_baremetrics_segment_remove_by_id","summary":"Delete Segment","description":"DELETE /v1/segments/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/segment-find-without-save":{"post":{"operationId":"communication_baremetrics_segment_find_without_save","summary":"Search Segment","description":"POST /v1/segments/search","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"per_page":{"type":"integer","default":30},"page":{"type":"integer","default":0},"sort":{"type":"string","default":"created"},"order":{"type":"string","default":"asc"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/attribute-set-properties":{"post":{"operationId":"communication_baremetrics_attribute_set_properties","summary":"Set Attributes","description":"POST /v1/attributes","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/attribute-get-fields":{"get":{"operationId":"communication_baremetrics_attribute_get_fields","summary":"List Attribute Fields","description":"GET /v1/attributes/fields","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/attribute-create-field":{"post":{"operationId":"communication_baremetrics_attribute_create_field","summary":"Create Attribute Field","description":"POST /v1/attributes/fields","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/attribute-update-field":{"post":{"operationId":"communication_baremetrics_attribute_update_field","summary":"Update Attribute Field","description":"PUT /v1/attributes/fields/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/event-list-cancellation-insight-events":{"get":{"operationId":"communication_baremetrics_event_list_cancellation_insight_events","summary":"List Events","description":"GET /v1/cancellation_insights/events","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/event-create-insight-event":{"post":{"operationId":"communication_baremetrics_event_create_insight_event","summary":"Create Event","description":"POST /v1/cancellation_insights/events","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/event-get-event-by-id":{"get":{"operationId":"communication_baremetrics_event_get_event_by_id","summary":"Show Event","description":"GET /v1/cancellation_insights/events/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/event-update-event-by-id":{"post":{"operationId":"communication_baremetrics_event_update_event_by_id","summary":"Update Event","description":"PUT /v1/cancellation_insights/events/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/reason-show-details":{"get":{"operationId":"communication_baremetrics_reason_show_details","summary":"Show Reason","description":"GET /v1/cancellation_insights/reasons/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/reason-update-reason-by-id":{"post":{"operationId":"communication_baremetrics_reason_update_reason_by_id","summary":"Update Reason","description":"PUT /v1/cancellation_insights/reasons/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/reason-delete-by-id":{"post":{"operationId":"communication_baremetrics_reason_delete_by_id","summary":"Delete Reason","description":"DELETE /v1/cancellation_insights/reasons/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/reason-list-reasons":{"get":{"operationId":"communication_baremetrics_reason_list_reasons","summary":"List Reasons","description":"GET /v1/cancellation_insights/reasons","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:baremetrics/cancellation-insight-create-new-reason":{"post":{"operationId":"communication_baremetrics_cancellation_insight_create_new_reason","summary":"Create Reason","description":"POST /v1/cancellation_insights/reasons","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}