{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/payments:paddle/get-account":{"get":{"operationId":"payments_paddle_get_account","summary":"Get account","description":"GET /account","tags":["payments"],"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/payments:paddle/patch-account":{"post":{"operationId":"payments_paddle_patch_account","summary":"Update account","description":"PATCH /account","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/list-addresses":{"get":{"operationId":"payments_paddle_list_addresses","summary":"List addresses for a customer","description":"GET /customers/{customer_id}/addresses","tags":["payments"],"parameters":[{"name":"id","in":"query","required":false,"description":"Return only the IDs specified. Use a comma-separated list to get multiple entities.","schema":{"type":"array","description":"Return only the IDs specified. Use a comma-separated list to get multiple entities."}},{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":50,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"status","in":"query","required":false,"description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values.","schema":{"type":"array","description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values."}},{"name":"search","in":"query","required":false,"description":"Return entities that match a search query. Searches all fields except `status`, `created_at`, and `updated_at`.","schema":{"type":"string","description":"Return entities that match a search query. Searches all fields except `status`, `created_at`, and `updated_at`."}},{"name":"customer_id","in":"query","required":true,"description":"Paddle ID of the customer entity to work with.","schema":{"type":"string","description":"Paddle ID of the customer entity to work with."}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/create-address":{"post":{"operationId":"payments_paddle_create_address","summary":"Create an address for a customer","description":"POST /customers/{customer_id}/addresses","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customer_id","body"],"properties":{"customer_id":{"type":"string","description":"Paddle ID of the customer entity to work with."},"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/payments:paddle/get-address":{"get":{"operationId":"payments_paddle_get_address","summary":"Get an address for a customer","description":"GET /customers/{customer_id}/addresses/{address_id}","tags":["payments"],"parameters":[{"name":"address_id","in":"query","required":true,"description":"Paddle ID of the address entity to work with.","schema":{"type":"string","description":"Paddle ID of the address entity to work with."}},{"name":"customer_id","in":"query","required":true,"description":"Paddle ID of the customer entity to work with.","schema":{"type":"string","description":"Paddle ID of the customer entity to work with."}}],"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/payments:paddle/update-address":{"post":{"operationId":"payments_paddle_update_address","summary":"Update an address for a customer","description":"PATCH /customers/{customer_id}/addresses/{address_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["address_id","customer_id","body"],"properties":{"address_id":{"type":"string","description":"Paddle ID of the address entity to work with."},"customer_id":{"type":"string","description":"Paddle ID of the customer entity to work with."},"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/payments:paddle/list-adjustments":{"get":{"operationId":"payments_paddle_list_adjustments","summary":"List adjustments","description":"GET /adjustments","tags":["payments"],"parameters":[{"name":"id","in":"query","required":false,"description":"Return only the IDs specified. Use a comma-separated list to get multiple entities.","schema":{"type":"array","description":"Return only the IDs specified. Use a comma-separated list to get multiple entities."}},{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"action","in":"query","required":false,"description":"Return entities for the specified action. Use a comma-separated list to specify multiple action values.","schema":{"type":"array","description":"Return entities for the specified action. Use a comma-separated list to specify multiple action values."}},{"name":"customer_id","in":"query","required":false,"description":"Return entities related to the specified customer. Use a comma-separated list to specify multiple customer IDs.","schema":{"type":"array","description":"Return entities related to the specified customer. Use a comma-separated list to specify multiple customer IDs."}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":10,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"status","in":"query","required":false,"description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values.","schema":{"type":"array","description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values."}},{"name":"subscription_id","in":"query","required":false,"description":"Return entities related to the specified subscription. Use a comma-separated list to specify multiple subscription IDs.","schema":{"type":"array","description":"Return entities related to the specified subscription. Use a comma-separated list to specify multiple subscription IDs."}},{"name":"transaction_id","in":"query","required":false,"description":"Return entities related to the specified transaction. Use a comma-separated list to specify multiple transaction IDs.","schema":{"type":"array","description":"Return entities related to the specified transaction. Use a comma-separated list to specify multiple transaction IDs."}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/create-adjustment":{"post":{"operationId":"payments_paddle_create_adjustment","summary":"Create an adjustment","description":"POST /adjustments","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/get-adjustment-credit-note":{"get":{"operationId":"payments_paddle_get_adjustment_credit_note","summary":"Get a PDF credit note for an adjustment","description":"GET /adjustments/{adjustment_id}/credit-note","tags":["payments"],"parameters":[{"name":"adjustment_id","in":"query","required":true,"description":"Paddle ID of the adjustment entity to work with.","schema":{"type":"string","description":"Paddle ID of the adjustment entity to work with."}},{"name":"disposition","in":"query","required":false,"description":"Determine whether the generated URL should download the PDF as an attachment saved locally, or open it inline in the browser. Default:…","schema":{"type":"string","enum":["attachment","inline"],"description":"Determine whether the generated URL should download the PDF as an attachment saved locally, or open it inline in the browser. Default:…"}}],"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/payments:paddle/get-balance-currency":{"get":{"operationId":"payments_paddle_get_balance_currency","summary":"Get balance currency settings","description":"GET /settings/balance-currency","tags":["payments"],"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/payments:paddle/update-balance-currency":{"post":{"operationId":"payments_paddle_update_balance_currency","summary":"Update balance currency settings","description":"PATCH /settings/balance-currency","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/list-businesses":{"get":{"operationId":"payments_paddle_list_businesses","summary":"List businesses for a customer","description":"GET /customers/{customer_id}/businesses","tags":["payments"],"parameters":[{"name":"id","in":"query","required":false,"description":"Return only the IDs specified. Use a comma-separated list to get multiple entities.","schema":{"type":"array","description":"Return only the IDs specified. Use a comma-separated list to get multiple entities."}},{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":50,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"status","in":"query","required":false,"description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values.","schema":{"type":"array","description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values."}},{"name":"search","in":"query","required":false,"description":"Return entities that match a search query. Searches all fields, including contacts, except `status`, `created_at`, and `updated_at`.","schema":{"type":"string","description":"Return entities that match a search query. Searches all fields, including contacts, except `status`, `created_at`, and `updated_at`."}},{"name":"customer_id","in":"query","required":true,"description":"Paddle ID of the customer entity to work with.","schema":{"type":"string","description":"Paddle ID of the customer entity to work with."}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/create-business":{"post":{"operationId":"payments_paddle_create_business","summary":"Create a business for a customer","description":"POST /customers/{customer_id}/businesses","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customer_id","body"],"properties":{"customer_id":{"type":"string","description":"Paddle ID of the customer entity to work with."},"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/payments:paddle/get-business":{"get":{"operationId":"payments_paddle_get_business","summary":"Get a business for a customer","description":"GET /customers/{customer_id}/businesses/{business_id}","tags":["payments"],"parameters":[{"name":"business_id","in":"query","required":true,"description":"Paddle ID of the business entity to work with.","schema":{"type":"string","description":"Paddle ID of the business entity to work with."}},{"name":"customer_id","in":"query","required":true,"description":"Paddle ID of the customer entity to work with.","schema":{"type":"string","description":"Paddle ID of the customer entity to work with."}}],"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/payments:paddle/update-business":{"post":{"operationId":"payments_paddle_update_business","summary":"Update a business for a customer","description":"PATCH /customers/{customer_id}/businesses/{business_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["business_id","customer_id","body"],"properties":{"business_id":{"type":"string","description":"Paddle ID of the business entity to work with."},"customer_id":{"type":"string","description":"Paddle ID of the customer entity to work with."},"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/payments:paddle/list-checkout-domains":{"get":{"operationId":"payments_paddle_list_checkout_domains","summary":"List checkout domains","description":"GET /checkout-domains","tags":["payments"],"parameters":[{"name":"id","in":"query","required":false,"description":"Return only the IDs specified. Use a comma-separated list to get multiple entities.","schema":{"type":"array","description":"Return only the IDs specified. Use a comma-separated list to get multiple entities."}},{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":50,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"domain","in":"query","required":false,"description":"Filter results to include the specified fully qualified domain name (FQDN), its ancestors, and any of its subdomains. For example, if you…","schema":{"type":"string","description":"Filter results to include the specified fully qualified domain name (FQDN), its ancestors, and any of its subdomains. For example, if you…"}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"status","in":"query","required":false,"description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values.","schema":{"type":"array","description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values."}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/get-checkout-domain":{"get":{"operationId":"payments_paddle_get_checkout_domain","summary":"Get a checkout domain","description":"GET /checkout-domains/{domain_id}","tags":["payments"],"parameters":[{"name":"domain_id","in":"query","required":true,"description":"Paddle ID of the checkout domain entity to work with.","schema":{"type":"string","description":"Paddle ID of the checkout domain entity to work with."}}],"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/payments:paddle/delete-checkout-domain":{"post":{"operationId":"payments_paddle_delete_checkout_domain","summary":"Delete a checkout domain","description":"DELETE /checkout-domains/{domain_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain_id"],"properties":{"domain_id":{"type":"string","description":"Paddle ID of the checkout domain entity to work with."}}}}}},"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/payments:paddle/verify-checkout-domain-payment-method":{"post":{"operationId":"payments_paddle_verify_checkout_domain_payment_method","summary":"Verify a payment method for a checkout domain","description":"POST /checkout-domains/{domain_id}/verify-payment-method","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain_id","body"],"properties":{"domain_id":{"type":"string","description":"Paddle ID of the checkout domain entity to work with."},"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/payments:paddle/get-checkout-features":{"get":{"operationId":"payments_paddle_get_checkout_features","summary":"Get checkout feature settings","description":"GET /settings/checkout-features","tags":["payments"],"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/payments:paddle/update-checkout-features":{"post":{"operationId":"payments_paddle_update_checkout_features","summary":"Update checkout feature settings","description":"PATCH /settings/checkout-features","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/get-checkout-payment-method-settings":{"get":{"operationId":"payments_paddle_get_checkout_payment_method_settings","summary":"Get checkout payment method settings","description":"GET /settings/checkout-payment-methods","tags":["payments"],"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/payments:paddle/update-checkout-payment-method-settings":{"post":{"operationId":"payments_paddle_update_checkout_payment_method_settings","summary":"Update checkout payment method settings","description":"PATCH /settings/checkout-payment-methods","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/get-checkout-recovery":{"get":{"operationId":"payments_paddle_get_checkout_recovery","summary":"Get checkout recovery settings","description":"GET /settings/checkout-recovery","tags":["payments"],"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/payments:paddle/update-checkout-recovery":{"post":{"operationId":"payments_paddle_update_checkout_recovery","summary":"Update checkout recovery settings","description":"PATCH /settings/checkout-recovery","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/get-checkout-styles-overlay":{"get":{"operationId":"payments_paddle_get_checkout_styles_overlay","summary":"Get overlay checkout style settings","description":"GET /settings/checkout-styles-overlay","tags":["payments"],"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/payments:paddle/update-checkout-styles-overlay":{"post":{"operationId":"payments_paddle_update_checkout_styles_overlay","summary":"Update overlay checkout style settings","description":"PATCH /settings/checkout-styles-overlay","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/get-checkout-url":{"get":{"operationId":"payments_paddle_get_checkout_url","summary":"Get checkout URL settings","description":"GET /settings/checkout-url","tags":["payments"],"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/payments:paddle/update-checkout-url":{"post":{"operationId":"payments_paddle_update_checkout_url","summary":"Update checkout URL settings","description":"PATCH /settings/checkout-url","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/list-client-tokens":{"get":{"operationId":"payments_paddle_list_client_tokens","summary":"List client-side tokens","description":"GET /client-tokens","tags":["payments"],"parameters":[{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":50,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"status","in":"query","required":false,"description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values.","schema":{"type":"array","description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values."}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/create-client-token":{"post":{"operationId":"payments_paddle_create_client_token","summary":"Create a client-side token","description":"POST /client-tokens","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/get-client-token":{"get":{"operationId":"payments_paddle_get_client_token","summary":"Get a client-side token","description":"GET /client-tokens/{client_token_id}","tags":["payments"],"parameters":[{"name":"client_token_id","in":"query","required":true,"description":"Paddle ID of the client-side token entity.","schema":{"type":"string","description":"Paddle ID of the client-side token entity."}}],"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/payments:paddle/update-client-token":{"post":{"operationId":"payments_paddle_update_client_token","summary":"Update a client-side token","description":"PATCH /client-tokens/{client_token_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["client_token_id","body"],"properties":{"client_token_id":{"type":"string","description":"Paddle ID of the client-side token entity."},"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/payments:paddle/list-countries":{"get":{"operationId":"payments_paddle_list_countries","summary":"List Paddle countries","description":"GET /countries","tags":["payments"],"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/payments:paddle/list-currencies":{"get":{"operationId":"payments_paddle_list_currencies","summary":"List Paddle currencies","description":"GET /currencies","tags":["payments"],"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/payments:paddle/get-currency-conversions":{"get":{"operationId":"payments_paddle_get_currency_conversions","summary":"Get currency conversion settings","description":"GET /settings/currency-conversions","tags":["payments"],"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/payments:paddle/update-currency-conversions":{"post":{"operationId":"payments_paddle_update_currency_conversions","summary":"Update currency conversion settings","description":"PATCH /settings/currency-conversions","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/list-customers":{"get":{"operationId":"payments_paddle_list_customers","summary":"List customers","description":"GET /customers","tags":["payments"],"parameters":[{"name":"id","in":"query","required":false,"description":"Return only the IDs specified. Use a comma-separated list to get multiple entities.","schema":{"type":"array","description":"Return only the IDs specified. Use a comma-separated list to get multiple entities."}},{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":50,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"email","in":"query","required":false,"description":"Return entities that exactly match the specified email address. Use a comma-separated list to specify multiple email addresses.…","schema":{"type":"array","description":"Return entities that exactly match the specified email address. Use a comma-separated list to specify multiple email addresses.…"}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"status","in":"query","required":false,"description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values.","schema":{"type":"array","description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values."}},{"name":"search","in":"query","required":false,"description":"Return entities that match a search query. Searches `id`, `name`, and `email` fields. Use the `email` query parameter for precise matching…","schema":{"type":"string","description":"Return entities that match a search query. Searches `id`, `name`, and `email` fields. Use the `email` query parameter for precise matching…"}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/create-customer":{"post":{"operationId":"payments_paddle_create_customer","summary":"Create a customer","description":"POST /customers","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/get-customer":{"get":{"operationId":"payments_paddle_get_customer","summary":"Get a customer","description":"GET /customers/{customer_id}","tags":["payments"],"parameters":[{"name":"customer_id","in":"query","required":true,"description":"Paddle ID of the customer entity to work with.","schema":{"type":"string","description":"Paddle ID of the customer entity to work with."}}],"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/payments:paddle/update-customer":{"post":{"operationId":"payments_paddle_update_customer","summary":"Update a customer","description":"PATCH /customers/{customer_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customer_id","body"],"properties":{"customer_id":{"type":"string","description":"Paddle ID of the customer entity to work with."},"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/payments:paddle/list-credit-balances":{"get":{"operationId":"payments_paddle_list_credit_balances","summary":"List credit balances for a customer","description":"GET /customers/{customer_id}/credit-balances","tags":["payments"],"parameters":[{"name":"customer_id","in":"query","required":true,"description":"Paddle ID of the customer entity to work with.","schema":{"type":"string","description":"Paddle ID of the customer entity to work with."}},{"name":"currency_code","in":"query","required":false,"description":"Return entities that match the currency code. Use a comma-separated list to specify multiple currency codes.","schema":{"type":"array","description":"Return entities that match the currency code. Use a comma-separated list to specify multiple currency codes."}}],"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/payments:paddle/generate-customer-authentication-token":{"post":{"operationId":"payments_paddle_generate_customer_authentication_token","summary":"Generate an authentication token for a customer","description":"POST /customers/{customer_id}/auth-token","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customer_id"],"properties":{"customer_id":{"type":"string","description":"Paddle ID of the customer entity to work with."}}}}}},"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/payments:paddle/create-customer-portal-session":{"post":{"operationId":"payments_paddle_create_customer_portal_session","summary":"Create a customer portal session","description":"POST /customers/{customer_id}/portal-sessions","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customer_id","body"],"properties":{"customer_id":{"type":"string","description":"Paddle ID of the customer entity to work with."},"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/payments:paddle/list-discount-groups":{"get":{"operationId":"payments_paddle_list_discount_groups","summary":"List discount groups","description":"GET /discount-groups","tags":["payments"],"parameters":[{"name":"id","in":"query","required":false,"description":"Return only the IDs specified. Use a comma-separated list to get multiple entities.","schema":{"type":"array","description":"Return only the IDs specified. Use a comma-separated list to get multiple entities."}},{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":50,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/create-discount-group":{"post":{"operationId":"payments_paddle_create_discount_group","summary":"Create a discount group","description":"POST /discount-groups","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/get-discount-group":{"get":{"operationId":"payments_paddle_get_discount_group","summary":"Get a discount group","description":"GET /discount-groups/{discount_group_id}","tags":["payments"],"parameters":[{"name":"discount_group_id","in":"query","required":true,"description":"Paddle ID of the discount group entity to work with.","schema":{"type":"string","description":"Paddle ID of the discount group entity to work with."}}],"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/payments:paddle/update-discount-group":{"post":{"operationId":"payments_paddle_update_discount_group","summary":"Update a discount group","description":"PATCH /discount-groups/{discount_group_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["discount_group_id","body"],"properties":{"discount_group_id":{"type":"string","description":"Paddle ID of the discount group entity to work with."},"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/payments:paddle/list-discounts":{"get":{"operationId":"payments_paddle_list_discounts","summary":"List discounts","description":"GET /discounts","tags":["payments"],"parameters":[{"name":"id","in":"query","required":false,"description":"Return only the IDs specified. Use a comma-separated list to get multiple entities.","schema":{"type":"array","description":"Return only the IDs specified. Use a comma-separated list to get multiple entities."}},{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":50,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"include","in":"query","required":false,"description":"Include related entities in the response. Use a comma-separated list to specify multiple entities.","schema":{"type":"array","description":"Include related entities in the response. Use a comma-separated list to specify multiple entities."}},{"name":"code","in":"query","required":false,"description":"Return entities that match the discount code. Use a comma-separated list to specify multiple discount codes.","schema":{"type":"array","description":"Return entities that match the discount code. Use a comma-separated list to specify multiple discount codes."}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"status","in":"query","required":false,"description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values.","schema":{"type":"array","description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values."}},{"name":"mode","in":"query","required":false,"description":"Return entities that match the specified mode.","schema":{"type":"string","enum":["standard","custom"],"description":"Return entities that match the specified mode."}},{"name":"discount_group_id","in":"query","required":false,"description":"Return entities related to the specified discount group. Use a comma-separated list to specify multiple discount group IDs.","schema":{"type":"array","description":"Return entities related to the specified discount group. Use a comma-separated list to specify multiple discount group IDs."}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/create-discount":{"post":{"operationId":"payments_paddle_create_discount","summary":"Create a discount","description":"POST /discounts","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/get-discount":{"get":{"operationId":"payments_paddle_get_discount","summary":"Get a discount","description":"GET /discounts/{discount_id}","tags":["payments"],"parameters":[{"name":"include","in":"query","required":false,"description":"Include related entities in the response. Use a comma-separated list to specify multiple entities.","schema":{"type":"array","description":"Include related entities in the response. Use a comma-separated list to specify multiple entities."}},{"name":"discount_id","in":"query","required":true,"description":"Paddle ID of the discount entity to work with.","schema":{"type":"string","description":"Paddle ID of the discount entity to work with."}}],"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/payments:paddle/update-discount":{"post":{"operationId":"payments_paddle_update_discount","summary":"Update a discount","description":"PATCH /discounts/{discount_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["discount_id","body"],"properties":{"discount_id":{"type":"string","description":"Paddle ID of the discount entity to work with."},"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/payments:paddle/list-event-types":{"get":{"operationId":"payments_paddle_list_event_types","summary":"List events types","description":"GET /event-types","tags":["payments"],"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/payments:paddle/list-events":{"get":{"operationId":"payments_paddle_list_events","summary":"List events","description":"GET /events","tags":["payments"],"parameters":[{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":50,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"event_type","in":"query","required":false,"description":"Return events that match the specified event type. Use a comma-separated list to specify multiple event types.","schema":{"type":"array","description":"Return events that match the specified event type. Use a comma-separated list to specify multiple event types."}},{"name":"filter","in":"query","required":false,"description":"Return entities that contain the value specified. Pass a Paddle ID or email address that appears in the event payload, or part of one.…","schema":{"type":"string","description":"Return entities that contain the value specified. Pass a Paddle ID or email address that appears in the event payload, or part of one.…"}},{"name":"to","in":"query","required":false,"description":"Return entities up to a specific time. Pass an RFC 3339 datetime string.","schema":{"type":"string","description":"Return entities up to a specific time. Pass an RFC 3339 datetime string."}},{"name":"from","in":"query","required":false,"description":"Return entities from a specific time. Pass an RFC 3339 datetime string.","schema":{"type":"string","description":"Return entities from a specific time. Pass an RFC 3339 datetime string."}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/get-ip-addresses":{"get":{"operationId":"payments_paddle_get_ip_addresses","summary":"Get Paddle IP addresses","description":"GET /ips","tags":["payments"],"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/payments:paddle/list-explore-metric-entities":{"get":{"operationId":"payments_paddle_list_explore_metric_entities","summary":"List Explore metric entities","description":"GET /metrics/explore/entities","tags":["payments"],"parameters":[{"name":"entity","in":"query","required":false,"description":"Return the metric that matches the specified entity name. Omit to return all metrics that are available. An unknown value, including…","schema":{"type":"string","enum":["transactions.completed","adjustments.refunds","adjustments.chargebacks","checkouts","subscriptions"],"description":"Return the metric that matches the specified entity name. Omit to return all metrics that are available. An unknown value, including…"}}],"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/payments:paddle/run-explore-metrics-query":{"post":{"operationId":"payments_paddle_run_explore_metrics_query","summary":"Run an Explore metrics query","description":"POST /metrics/explore","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"after":{"type":"string","description":"Pagination cursor from the previous response's `meta.pagination.next`. Omit for the first page. Send the same request body with it: a…"},"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/payments:paddle/get-metrics-monthly-recurring-revenue":{"get":{"operationId":"payments_paddle_get_metrics_monthly_recurring_revenue","summary":"Get MRR (monthly recurring revenue) metrics","description":"GET /metrics/monthly-recurring-revenue","tags":["payments"],"parameters":[{"name":"from","in":"query","required":true,"description":"Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`.","schema":{"type":"string","description":"Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`."}},{"name":"to","in":"query","required":true,"description":"Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`.","schema":{"type":"string","description":"Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`."}}],"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/payments:paddle/get-metrics-active-subscribers":{"get":{"operationId":"payments_paddle_get_metrics_active_subscribers","summary":"Get active subscribers metrics","description":"GET /metrics/active-subscribers","tags":["payments"],"parameters":[{"name":"from","in":"query","required":true,"description":"Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`.","schema":{"type":"string","description":"Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`."}},{"name":"to","in":"query","required":true,"description":"Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`.","schema":{"type":"string","description":"Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`."}}],"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/payments:paddle/get-metrics-monthly-recurring-revenue-change":{"get":{"operationId":"payments_paddle_get_metrics_monthly_recurring_revenue_change","summary":"Get MRR change (monthly recurring revenue change) metrics","description":"GET /metrics/monthly-recurring-revenue-change","tags":["payments"],"parameters":[{"name":"from","in":"query","required":true,"description":"Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`.","schema":{"type":"string","description":"Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`."}},{"name":"to","in":"query","required":true,"description":"Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`.","schema":{"type":"string","description":"Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`."}}],"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/payments:paddle/get-metrics-revenue":{"get":{"operationId":"payments_paddle_get_metrics_revenue","summary":"Get net revenue metrics","description":"GET /metrics/revenue","tags":["payments"],"parameters":[{"name":"from","in":"query","required":true,"description":"Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`.","schema":{"type":"string","description":"Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`."}},{"name":"to","in":"query","required":true,"description":"Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`.","schema":{"type":"string","description":"Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`."}}],"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/payments:paddle/get-metrics-refunds":{"get":{"operationId":"payments_paddle_get_metrics_refunds","summary":"Get refund metrics","description":"GET /metrics/refunds","tags":["payments"],"parameters":[{"name":"from","in":"query","required":true,"description":"Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`.","schema":{"type":"string","description":"Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`."}},{"name":"to","in":"query","required":true,"description":"Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`.","schema":{"type":"string","description":"Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`."}}],"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/payments:paddle/get-metrics-chargebacks":{"get":{"operationId":"payments_paddle_get_metrics_chargebacks","summary":"Get chargeback metrics","description":"GET /metrics/chargebacks","tags":["payments"],"parameters":[{"name":"from","in":"query","required":true,"description":"Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`.","schema":{"type":"string","description":"Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`."}},{"name":"to","in":"query","required":true,"description":"Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`.","schema":{"type":"string","description":"Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`."}}],"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/payments:paddle/get-metrics-checkout-conversion":{"get":{"operationId":"payments_paddle_get_metrics_checkout_conversion","summary":"Get checkout conversion metrics","description":"GET /metrics/checkout-conversion","tags":["payments"],"parameters":[{"name":"from","in":"query","required":true,"description":"Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`.","schema":{"type":"string","description":"Return data from a specific date. Pass an RFC 3339 full-date string. Interpreted at 00:00 UTC. Must be before or the same as `to`."}},{"name":"to","in":"query","required":true,"description":"Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`.","schema":{"type":"string","description":"Return data up to a specific date. Pass an RFC 3339 full-date string. Interpreted as 00:00 UTC. Must be after or the same as `from`."}}],"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/payments:paddle/list-notification-settings":{"get":{"operationId":"payments_paddle_list_notification_settings","summary":"List notification settings","description":"GET /notification-settings","tags":["payments"],"parameters":[{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":200,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"active","in":"query","required":false,"description":"Determine whether returned entities are active (`true`) or not (`false`).","schema":{"type":"boolean","description":"Determine whether returned entities are active (`true`) or not (`false`)."}},{"name":"traffic_source","in":"query","required":false,"description":"Return entities that match the specified traffic source.","schema":{"type":"string","enum":["platform","simulation","all"],"description":"Return entities that match the specified traffic source."}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/create-notification-setting":{"post":{"operationId":"payments_paddle_create_notification_setting","summary":"Create a notification setting","description":"POST /notification-settings","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/get-notification-setting":{"get":{"operationId":"payments_paddle_get_notification_setting","summary":"Get a notification setting","description":"GET /notification-settings/{notification_setting_id}","tags":["payments"],"parameters":[{"name":"notification_setting_id","in":"query","required":true,"description":"Paddle ID of the notification setting entity (notification destination) to work with.","schema":{"type":"string","description":"Paddle ID of the notification setting entity (notification destination) to work with."}}],"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/payments:paddle/update-notification-setting":{"post":{"operationId":"payments_paddle_update_notification_setting","summary":"Update a notification setting","description":"PATCH /notification-settings/{notification_setting_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["notification_setting_id","body"],"properties":{"notification_setting_id":{"type":"string","description":"Paddle ID of the notification setting entity (notification destination) to work with."},"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/payments:paddle/delete-notification-setting":{"post":{"operationId":"payments_paddle_delete_notification_setting","summary":"Delete a notification setting","description":"DELETE /notification-settings/{notification_setting_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["notification_setting_id"],"properties":{"notification_setting_id":{"type":"string","description":"Paddle ID of the notification setting entity (notification destination) to work with."}}}}}},"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/payments:paddle/list-notifications":{"get":{"operationId":"payments_paddle_list_notifications","summary":"List notifications","description":"GET /notifications","tags":["payments"],"parameters":[{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":50,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"notification_setting_id","in":"query","required":false,"description":"Return entities related to the specified notification destination. Use a comma-separated list to specify multiple notification destination…","schema":{"type":"array","description":"Return entities related to the specified notification destination. Use a comma-separated list to specify multiple notification destination…"}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"search","in":"query","required":false,"description":"Return entities that match a search query. Searches `id` and `type` fields.","schema":{"type":"string","description":"Return entities that match a search query. Searches `id` and `type` fields."}},{"name":"status","in":"query","required":false,"description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values.","schema":{"type":"array","description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values."}},{"name":"filter","in":"query","required":false,"description":"Return entities that contain the value specified. Pass a Paddle ID or email address that appears in the event payload, or part of one.…","schema":{"type":"string","description":"Return entities that contain the value specified. Pass a Paddle ID or email address that appears in the event payload, or part of one.…"}},{"name":"to","in":"query","required":false,"description":"Return entities up to a specific time. Pass an RFC 3339 datetime string.","schema":{"type":"string","description":"Return entities up to a specific time. Pass an RFC 3339 datetime string."}},{"name":"from","in":"query","required":false,"description":"Return entities from a specific time. Pass an RFC 3339 datetime string.","schema":{"type":"string","description":"Return entities from a specific time. Pass an RFC 3339 datetime string."}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/get-notification":{"get":{"operationId":"payments_paddle_get_notification","summary":"Get a notification","description":"GET /notifications/{notification_id}","tags":["payments"],"parameters":[{"name":"notification_id","in":"query","required":true,"description":"Paddle ID of the notification entity to work with.","schema":{"type":"string","description":"Paddle ID of the notification entity to work with."}}],"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/payments:paddle/list-notification-logs":{"get":{"operationId":"payments_paddle_list_notification_logs","summary":"List logs for a notification","description":"GET /notifications/{notification_id}/logs","tags":["payments"],"parameters":[{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":50,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"notification_id","in":"query","required":true,"description":"Paddle ID of the notification entity to work with.","schema":{"type":"string","description":"Paddle ID of the notification entity to work with."}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/replay-notification":{"post":{"operationId":"payments_paddle_replay_notification","summary":"Replay a notification","description":"POST /notifications/{notification_id}/replay","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["notification_id"],"properties":{"notification_id":{"type":"string","description":"Paddle ID of the notification entity to work with."}}}}}},"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/payments:paddle/list-customer-payment-methods":{"get":{"operationId":"payments_paddle_list_customer_payment_methods","summary":"List payment methods for a customer","description":"GET /customers/{customer_id}/payment-methods","tags":["payments"],"parameters":[{"name":"customer_id","in":"query","required":true,"description":"Paddle ID of the customer entity to work with.","schema":{"type":"string","description":"Paddle ID of the customer entity to work with."}},{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":50,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"address_id","in":"query","required":false,"description":"Return entities related to the specified address. Use a comma-separated list to specify multiple address IDs.","schema":{"type":"array","description":"Return entities related to the specified address. Use a comma-separated list to specify multiple address IDs."}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"supports_checkout","in":"query","required":false,"description":"Return entities that support being presented at checkout (`true`) or not (`false`).","schema":{"type":"boolean","description":"Return entities that support being presented at checkout (`true`) or not (`false`)."}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/get-customer-payment-method":{"get":{"operationId":"payments_paddle_get_customer_payment_method","summary":"Get a payment method for a customer","description":"GET /customers/{customer_id}/payment-methods/{payment_method_id}","tags":["payments"],"parameters":[{"name":"customer_id","in":"query","required":true,"description":"Paddle ID of the customer entity to work with.","schema":{"type":"string","description":"Paddle ID of the customer entity to work with."}},{"name":"payment_method_id","in":"query","required":true,"description":"Paddle ID of the payment method entity to work with.","schema":{"type":"string","description":"Paddle ID of the payment method entity to work with."}}],"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/payments:paddle/delete-customer-payment-method":{"post":{"operationId":"payments_paddle_delete_customer_payment_method","summary":"Delete a payment method for a customer","description":"DELETE /customers/{customer_id}/payment-methods/{payment_method_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customer_id","payment_method_id"],"properties":{"customer_id":{"type":"string","description":"Paddle ID of the customer entity to work with."},"payment_method_id":{"type":"string","description":"Paddle ID of the payment method entity to work with."}}}}}},"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/payments:paddle/list-prices":{"get":{"operationId":"payments_paddle_list_prices","summary":"List prices","description":"GET /prices","tags":["payments"],"parameters":[{"name":"id","in":"query","required":false,"description":"Return only the IDs specified. Use a comma-separated list to get multiple entities.","schema":{"type":"array","description":"Return only the IDs specified. Use a comma-separated list to get multiple entities."}},{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":50,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"include","in":"query","required":false,"description":"Include related entities in the response.","schema":{"type":"array","description":"Include related entities in the response."}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"product_id","in":"query","required":false,"description":"Return entities related to the specified product. Use a comma-separated list to specify multiple product IDs.","schema":{"type":"array","description":"Return entities related to the specified product. Use a comma-separated list to specify multiple product IDs."}},{"name":"status","in":"query","required":false,"description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values.","schema":{"type":"array","description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values."}},{"name":"recurring","in":"query","required":false,"description":"Determine whether returned entities are for recurring prices (`true`) or one-time prices (`false`).","schema":{"type":"boolean","description":"Determine whether returned entities are for recurring prices (`true`) or one-time prices (`false`)."}},{"name":"billing_cycle.interval","in":"query","required":false,"description":"Return entities where the price billing cycle interval matches this value.","schema":{"type":"string","enum":["day","week","month","year"],"description":"Return entities where the price billing cycle interval matches this value."}},{"name":"billing_cycle.frequency","in":"query","required":false,"description":"Return entities where the price billing cycle frequency matches this value.","schema":{"type":"integer","description":"Return entities where the price billing cycle frequency matches this value."}},{"name":"type","in":"query","required":false,"description":"Return items that match the specified type.","schema":{"type":"string","enum":["custom","standard"],"description":"Return items that match the specified type."}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/create-price":{"post":{"operationId":"payments_paddle_create_price","summary":"Create a price","description":"POST /prices","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/get-price":{"get":{"operationId":"payments_paddle_get_price","summary":"Get a price","description":"GET /prices/{price_id}","tags":["payments"],"parameters":[{"name":"include","in":"query","required":false,"description":"Include related entities in the response.","schema":{"type":"array","description":"Include related entities in the response."}},{"name":"price_id","in":"query","required":true,"description":"Paddle ID of the price entity to work with.","schema":{"type":"string","description":"Paddle ID of the price entity to work with."}}],"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/payments:paddle/update-price":{"post":{"operationId":"payments_paddle_update_price","summary":"Update a price","description":"PATCH /prices/{price_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["price_id","body"],"properties":{"price_id":{"type":"string","description":"Paddle ID of the price entity to work with."},"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/payments:paddle/preview-prices":{"post":{"operationId":"payments_paddle_preview_prices","summary":"Preview prices","description":"POST /pricing-preview","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/list-products":{"get":{"operationId":"payments_paddle_list_products","summary":"List products","description":"GET /products","tags":["payments"],"parameters":[{"name":"id","in":"query","required":false,"description":"Return only the IDs specified. Use a comma-separated list to get multiple entities.","schema":{"type":"array","description":"Return only the IDs specified. Use a comma-separated list to get multiple entities."}},{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":50,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"include","in":"query","required":false,"description":"Include related entities in the response. Use a comma-separated list to specify multiple entities.","schema":{"type":"array","description":"Include related entities in the response. Use a comma-separated list to specify multiple entities."}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"status","in":"query","required":false,"description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values.","schema":{"type":"array","description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values."}},{"name":"tax_category","in":"query","required":false,"description":"Return entities that match the specified tax category. Use a comma-separated list to specify multiple tax categories.","schema":{"type":"array","description":"Return entities that match the specified tax category. Use a comma-separated list to specify multiple tax categories."}},{"name":"type","in":"query","required":false,"description":"Return items that match the specified type.","schema":{"type":"string","enum":["custom","standard"],"description":"Return items that match the specified type."}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/create-product":{"post":{"operationId":"payments_paddle_create_product","summary":"Create a product","description":"POST /products","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/get-product":{"get":{"operationId":"payments_paddle_get_product","summary":"Get a product","description":"GET /products/{product_id}","tags":["payments"],"parameters":[{"name":"include","in":"query","required":false,"description":"Include related entities in the response. Use a comma-separated list to specify multiple entities.","schema":{"type":"array","description":"Include related entities in the response. Use a comma-separated list to specify multiple entities."}},{"name":"product_id","in":"query","required":true,"description":"Paddle ID of the product entity to work with.","schema":{"type":"string","description":"Paddle ID of the product entity to work with."}}],"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/payments:paddle/update-product":{"post":{"operationId":"payments_paddle_update_product","summary":"Update a product","description":"PATCH /products/{product_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["product_id","body"],"properties":{"product_id":{"type":"string","description":"Paddle ID of the product entity to work with."},"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/payments:paddle/list-reports":{"get":{"operationId":"payments_paddle_list_reports","summary":"List reports","description":"GET /reports","tags":["payments"],"parameters":[{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":50,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"status","in":"query","required":false,"description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values.","schema":{"type":"array","description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values."}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/create-report":{"post":{"operationId":"payments_paddle_create_report","summary":"Create a report","description":"POST /reports","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/get-report":{"get":{"operationId":"payments_paddle_get_report","summary":"Get a report","description":"GET /reports/{report_id}","tags":["payments"],"parameters":[{"name":"report_id","in":"query","required":true,"description":"Paddle ID of the report entity.","schema":{"type":"string","description":"Paddle ID of the report entity."}}],"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/payments:paddle/get-report-csv":{"get":{"operationId":"payments_paddle_get_report_csv","summary":"Get a CSV file for a report","description":"GET /reports/{report_id}/download-url","tags":["payments"],"parameters":[{"name":"report_id","in":"query","required":true,"description":"Paddle ID of the report entity.","schema":{"type":"string","description":"Paddle ID of the report entity."}}],"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/payments:paddle/get-api-root":{"get":{"operationId":"payments_paddle_get_api_root","summary":"Get API root","description":"GET /","tags":["payments"],"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/payments:paddle/get-statement-descriptor-settings":{"get":{"operationId":"payments_paddle_get_statement_descriptor_settings","summary":"Get statement descriptor settings","description":"GET /settings/statement-descriptor","tags":["payments"],"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/payments:paddle/update-statement-descriptor-settings":{"post":{"operationId":"payments_paddle_update_statement_descriptor_settings","summary":"Update statement descriptor settings","description":"PATCH /settings/statement-descriptor","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/list-simulation-types":{"get":{"operationId":"payments_paddle_list_simulation_types","summary":"List simulation types","description":"GET /simulation-types","tags":["payments"],"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/payments:paddle/list-simulations":{"get":{"operationId":"payments_paddle_list_simulations","summary":"List simulations","description":"GET /simulations","tags":["payments"],"parameters":[{"name":"id","in":"query","required":false,"description":"Return only the IDs specified. Use a comma-separated list to get multiple entities.","schema":{"type":"array","description":"Return only the IDs specified. Use a comma-separated list to get multiple entities."}},{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":50,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"notification_setting_id","in":"query","required":false,"description":"Return entities related to the specified notification destination. Use a comma-separated list to specify multiple notification destination…","schema":{"type":"array","description":"Return entities related to the specified notification destination. Use a comma-separated list to specify multiple notification destination…"}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"status","in":"query","required":false,"description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values.","schema":{"type":"array","description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values."}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/create-simulation":{"post":{"operationId":"payments_paddle_create_simulation","summary":"Create a simulation","description":"POST /simulations","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/get-simulation":{"get":{"operationId":"payments_paddle_get_simulation","summary":"Get a simulation","description":"GET /simulations/{simulation_id}","tags":["payments"],"parameters":[{"name":"simulation_id","in":"query","required":true,"description":"Paddle ID of the simulation entity to work with.","schema":{"type":"string","description":"Paddle ID of the simulation entity to work with."}}],"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/payments:paddle/update-simulation":{"post":{"operationId":"payments_paddle_update_simulation","summary":"Update a simulation","description":"PATCH /simulations/{simulation_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["simulation_id","body"],"properties":{"simulation_id":{"type":"string","description":"Paddle ID of the simulation entity to work with."},"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/payments:paddle/list-simulation-runs":{"get":{"operationId":"payments_paddle_list_simulation_runs","summary":"List runs for a simulation","description":"GET /simulations/{simulation_id}/runs","tags":["payments"],"parameters":[{"name":"simulation_id","in":"query","required":true,"description":"Paddle ID of the simulation entity to work with.","schema":{"type":"string","description":"Paddle ID of the simulation entity to work with."}},{"name":"id","in":"query","required":false,"description":"Return only the IDs specified. Use a comma-separated list to get multiple entities.","schema":{"type":"array","description":"Return only the IDs specified. Use a comma-separated list to get multiple entities."}},{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":50,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"include","in":"query","required":false,"description":"Include related entities in the response.","schema":{"type":"array","description":"Include related entities in the response."}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/create-simulation-run":{"post":{"operationId":"payments_paddle_create_simulation_run","summary":"Create a run for a simulation","description":"POST /simulations/{simulation_id}/runs","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["simulation_id"],"properties":{"simulation_id":{"type":"string","description":"Paddle ID of the simulation entity to work with."}}}}}},"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/payments:paddle/get-simulation-run":{"get":{"operationId":"payments_paddle_get_simulation_run","summary":"Get a run for a simulation","description":"GET /simulations/{simulation_id}/runs/{simulation_run_id}","tags":["payments"],"parameters":[{"name":"simulation_id","in":"query","required":true,"description":"Paddle ID of the simulation entity to work with.","schema":{"type":"string","description":"Paddle ID of the simulation entity to work with."}},{"name":"simulation_run_id","in":"query","required":true,"description":"Paddle ID of the simulation run entity to work with.","schema":{"type":"string","description":"Paddle ID of the simulation run entity to work with."}},{"name":"include","in":"query","required":false,"description":"Include related entities in the response.","schema":{"type":"array","description":"Include related entities in the response."}}],"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/payments:paddle/list-simulations-events":{"get":{"operationId":"payments_paddle_list_simulations_events","summary":"List events for a simulation run","description":"GET /simulations/{simulation_id}/runs/{simulation_run_id}/events","tags":["payments"],"parameters":[{"name":"simulation_id","in":"query","required":true,"description":"Paddle ID of the simulation entity to work with.","schema":{"type":"string","description":"Paddle ID of the simulation entity to work with."}},{"name":"simulation_run_id","in":"query","required":true,"description":"Paddle ID of the simulation run entity to work with.","schema":{"type":"string","description":"Paddle ID of the simulation run entity to work with."}},{"name":"id","in":"query","required":false,"description":"Return only the IDs specified. Use a comma-separated list to get multiple entities.","schema":{"type":"array","description":"Return only the IDs specified. Use a comma-separated list to get multiple entities."}},{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":50,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/get-simulation-event":{"get":{"operationId":"payments_paddle_get_simulation_event","summary":"Get an event for a simulation run","description":"GET /simulations/{simulation_id}/runs/{simulation_run_id}/events/{simulation_event_id}","tags":["payments"],"parameters":[{"name":"simulation_id","in":"query","required":true,"description":"Paddle ID of the simulation entity to work with.","schema":{"type":"string","description":"Paddle ID of the simulation entity to work with."}},{"name":"simulation_run_id","in":"query","required":true,"description":"Paddle ID of the simulation run entity to work with.","schema":{"type":"string","description":"Paddle ID of the simulation run entity to work with."}},{"name":"simulation_event_id","in":"query","required":true,"description":"Paddle ID of the simulation event entity to work with.","schema":{"type":"string","description":"Paddle ID of the simulation event entity to work with."}}],"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/payments:paddle/replay-simulation-run-event":{"post":{"operationId":"payments_paddle_replay_simulation_run_event","summary":"Replay an event for a simulation run","description":"POST /simulations/{simulation_id}/runs/{simulation_run_id}/events/{simulation_event_id}/replay","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["simulation_id","simulation_run_id","simulation_event_id"],"properties":{"simulation_id":{"type":"string","description":"Paddle ID of the simulation entity to work with."},"simulation_run_id":{"type":"string","description":"Paddle ID of the simulation run entity to work with."},"simulation_event_id":{"type":"string","description":"Paddle ID of the simulation event entity to work with."}}}}}},"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/payments:paddle/list-subscription-history":{"get":{"operationId":"payments_paddle_list_subscription_history","summary":"List history for a subscription","description":"GET /subscriptions/{subscription_id}/history","tags":["payments"],"parameters":[{"name":"subscription_id","in":"query","required":true,"description":"Unique Paddle ID for this subscription entity, prefixed with `sub_`.","schema":{"type":"string","description":"Unique Paddle ID for this subscription entity, prefixed with `sub_`."}},{"name":"action","in":"query","required":false,"description":"Return history entries that match the specified action. Use a comma-separated list to specify multiple action values.","schema":{"type":"array","description":"Return history entries that match the specified action. Use a comma-separated list to specify multiple action values."}},{"name":"source","in":"query","required":false,"description":"Return history entries that match the specified source. Use a comma-separated list to specify multiple source values.","schema":{"type":"array","description":"Return history entries that match the specified source. Use a comma-separated list to specify multiple source values."}},{"name":"actor_type","in":"query","required":false,"description":"Return history entries that match the specified actor type. Use a comma-separated list to specify multiple actor type values.","schema":{"type":"array","description":"Return history entries that match the specified actor type. Use a comma-separated list to specify multiple actor type values."}},{"name":"actor_id","in":"query","required":false,"description":"Return history entries that match the specified actor ID. Use a comma-separated list to specify multiple actor ID values. Only applicable…","schema":{"type":"array","description":"Return history entries that match the specified actor ID. Use a comma-separated list to specify multiple actor ID values. Only applicable…"}},{"name":"reason","in":"query","required":false,"description":"Return history entries that match the specified reason. Use a comma-separated list to specify multiple reason values.","schema":{"type":"array","description":"Return history entries that match the specified reason. Use a comma-separated list to specify multiple reason values."}},{"name":"occurred_at","in":"query","required":false,"description":"Return entities that occurred at a specific time. Use `[LTE]` (less than or equal to) or `[GTE]` (greater than or equal to) operators with…","schema":{"type":"string","description":"Return entities that occurred at a specific time. Use `[LTE]` (less than or equal to) or `[GTE]` (greater than or equal to) operators with…"}},{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":50,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[DESC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[DESC]`. Valid fields for…"}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/list-subscriptions":{"get":{"operationId":"payments_paddle_list_subscriptions","summary":"List subscriptions","description":"GET /subscriptions","tags":["payments"],"parameters":[{"name":"id","in":"query","required":false,"description":"Return only the IDs specified. Use a comma-separated list to get multiple entities.","schema":{"type":"array","description":"Return only the IDs specified. Use a comma-separated list to get multiple entities."}},{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":50,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"address_id","in":"query","required":false,"description":"Return entities related to the specified address. Use a comma-separated list to specify multiple address IDs.","schema":{"type":"array","description":"Return entities related to the specified address. Use a comma-separated list to specify multiple address IDs."}},{"name":"collection_mode","in":"query","required":false,"description":"Return entities that match the specified collection mode.","schema":{"type":"string","enum":["automatic","manual"],"description":"Return entities that match the specified collection mode."}},{"name":"customer_id","in":"query","required":false,"description":"Return entities related to the specified customer. Use a comma-separated list to specify multiple customer IDs.","schema":{"type":"array","description":"Return entities related to the specified customer. Use a comma-separated list to specify multiple customer IDs."}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"price_id","in":"query","required":false,"description":"Return entities related to the specified price. Use a comma-separated list to specify multiple price IDs.","schema":{"type":"array","description":"Return entities related to the specified price. Use a comma-separated list to specify multiple price IDs."}},{"name":"scheduled_change_action","in":"query","required":false,"description":"Return subscriptions that have a scheduled change. Use a comma-separated list to specify multiple scheduled change actions.","schema":{"type":"array","description":"Return subscriptions that have a scheduled change. Use a comma-separated list to specify multiple scheduled change actions."}},{"name":"next_billed_at","in":"query","required":false,"description":"Return entities next billed at a specific time. Pass `null` to return entities with no next billing date.","schema":{"type":"string","description":"Return entities next billed at a specific time. Pass `null` to return entities with no next billing date."}},{"name":"status","in":"query","required":false,"description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values.","schema":{"type":"array","description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values."}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/get-subscription":{"get":{"operationId":"payments_paddle_get_subscription","summary":"Get a subscription","description":"GET /subscriptions/{subscription_id}","tags":["payments"],"parameters":[{"name":"include","in":"query","required":false,"description":"Include related entities in the response. Use a comma-separated list to specify multiple entities.","schema":{"type":"array","description":"Include related entities in the response. Use a comma-separated list to specify multiple entities."}},{"name":"subscription_id","in":"query","required":true,"description":"Paddle ID of the subscription entity to work with.","schema":{"type":"string","description":"Paddle ID of the subscription entity to work with."}}],"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/payments:paddle/update-subscription":{"post":{"operationId":"payments_paddle_update_subscription","summary":"Update a subscription","description":"PATCH /subscriptions/{subscription_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription_id","body"],"properties":{"subscription_id":{"type":"string","description":"Paddle ID of the subscription entity to work with."},"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/payments:paddle/cancel-subscription":{"post":{"operationId":"payments_paddle_cancel_subscription","summary":"Cancel a subscription","description":"POST /subscriptions/{subscription_id}/cancel","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription_id","body"],"properties":{"subscription_id":{"type":"string","description":"Paddle ID of the subscription entity to work with."},"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/payments:paddle/pause-subscription":{"post":{"operationId":"payments_paddle_pause_subscription","summary":"Pause a subscription","description":"POST /subscriptions/{subscription_id}/pause","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription_id","body"],"properties":{"subscription_id":{"type":"string","description":"Paddle ID of the subscription entity to work with."},"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/payments:paddle/resume-subscription":{"post":{"operationId":"payments_paddle_resume_subscription","summary":"Resume a paused subscription","description":"POST /subscriptions/{subscription_id}/resume","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription_id","body"],"properties":{"subscription_id":{"type":"string","description":"Paddle ID of the subscription entity to work with."},"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/payments:paddle/activate-subscription":{"post":{"operationId":"payments_paddle_activate_subscription","summary":"Activate a trialing subscription","description":"POST /subscriptions/{subscription_id}/activate","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription_id"],"properties":{"subscription_id":{"type":"string","description":"Paddle ID of the subscription entity to work with."}}}}}},"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/payments:paddle/get-subscription-update-payment-method-transaction":{"get":{"operationId":"payments_paddle_get_subscription_update_payment_method_transaction","summary":"Get a transaction to update payment method","description":"GET /subscriptions/{subscription_id}/update-payment-method-transaction","tags":["payments"],"parameters":[{"name":"subscription_id","in":"query","required":true,"description":"Paddle ID of the subscription entity to work with.","schema":{"type":"string","description":"Paddle ID of the subscription entity to work with."}}],"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/payments:paddle/preview-subscription-update":{"post":{"operationId":"payments_paddle_preview_subscription_update","summary":"Preview an update to a subscription","description":"PATCH /subscriptions/{subscription_id}/preview","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription_id","body"],"properties":{"subscription_id":{"type":"string","description":"Paddle ID of the subscription entity to work with."},"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/payments:paddle/create-subscription-charge":{"post":{"operationId":"payments_paddle_create_subscription_charge","summary":"Create a one-time charge for a subscription","description":"POST /subscriptions/{subscription_id}/charge","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription_id","body"],"properties":{"subscription_id":{"type":"string","description":"Paddle ID of the subscription entity to work with."},"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/payments:paddle/preview-subscription-charge":{"post":{"operationId":"payments_paddle_preview_subscription_charge","summary":"Preview a one-time charge for a subscription","description":"POST /subscriptions/{subscription_id}/charge/preview","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription_id","body"],"properties":{"subscription_id":{"type":"string","description":"Paddle ID of the subscription entity to work with."},"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/payments:paddle/get-tax-settings":{"get":{"operationId":"payments_paddle_get_tax_settings","summary":"Get tax settings","description":"GET /settings/tax","tags":["payments"],"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/payments:paddle/update-tax-settings":{"post":{"operationId":"payments_paddle_update_tax_settings","summary":"Update tax settings","description":"PATCH /settings/tax","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/list-transactions":{"get":{"operationId":"payments_paddle_list_transactions","summary":"List transactions","description":"GET /transactions","tags":["payments"],"parameters":[{"name":"include","in":"query","required":false,"description":"Include related entities in the response. Use a comma-separated list to specify multiple entities.","schema":{"type":"array","description":"Include related entities in the response. Use a comma-separated list to specify multiple entities."}},{"name":"id","in":"query","required":false,"description":"Return only the IDs specified. Use a comma-separated list to get multiple entities.","schema":{"type":"array","description":"Return only the IDs specified. Use a comma-separated list to get multiple entities."}},{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"billed_at","in":"query","required":false,"description":"Return entities billed at a specific time. Pass an RFC 3339 datetime string, or use `[LT]` (less than), `[LTE]` (less than or equal to),…","schema":{"type":"string","description":"Return entities billed at a specific time. Pass an RFC 3339 datetime string, or use `[LT]` (less than), `[LTE]` (less than or equal to),…"}},{"name":"collection_mode","in":"query","required":false,"description":"Return entities that match the specified collection mode.","schema":{"type":"string","enum":["automatic","manual"],"description":"Return entities that match the specified collection mode."}},{"name":"created_at","in":"query","required":false,"description":"Return entities created at a specific time. Pass an RFC 3339 datetime string, or use `[LT]` (less than), `[LTE]` (less than or equal to),…","schema":{"type":"string","description":"Return entities created at a specific time. Pass an RFC 3339 datetime string, or use `[LT]` (less than), `[LTE]` (less than or equal to),…"}},{"name":"customer_id","in":"query","required":false,"description":"Return entities related to the specified customer. Use a comma-separated list to specify multiple customer IDs.","schema":{"type":"array","description":"Return entities related to the specified customer. Use a comma-separated list to specify multiple customer IDs."}},{"name":"invoice_number","in":"query","required":false,"description":"Return entities that match the invoice number. Use a comma-separated list to specify multiple invoice numbers.","schema":{"type":"array","description":"Return entities that match the invoice number. Use a comma-separated list to specify multiple invoice numbers."}},{"name":"origin","in":"query","required":false,"description":"Return entities related to the specified origin. Use a comma-separated list to specify multiple origins.","schema":{"type":"array","description":"Return entities related to the specified origin. Use a comma-separated list to specify multiple origins."}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"status","in":"query","required":false,"description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values.","schema":{"type":"array","description":"Return entities that match the specified status. Use a comma-separated list to specify multiple status values."}},{"name":"subscription_id","in":"query","required":false,"description":"Return entities related to the specified subscription. Use a comma-separated list to specify multiple subscription IDs. Pass `null` to…","schema":{"type":"string","description":"Return entities related to the specified subscription. Use a comma-separated list to specify multiple subscription IDs. Pass `null` to…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":30,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"updated_at","in":"query","required":false,"description":"Return entities updated at a specific time. Pass an RFC 3339 datetime string, or use `[LT]` (less than), `[LTE]` (less than or equal to),…","schema":{"type":"string","description":"Return entities updated at a specific time. Pass an RFC 3339 datetime string, or use `[LT]` (less than), `[LTE]` (less than or equal to),…"}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/create-transaction":{"post":{"operationId":"payments_paddle_create_transaction","summary":"Create a transaction","description":"POST /transactions","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"include":{"type":"array","description":"Include related entities in the response. Use a comma-separated list to specify multiple entities."},"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/payments:paddle/get-transaction":{"get":{"operationId":"payments_paddle_get_transaction","summary":"Get a transaction","description":"GET /transactions/{transaction_id}","tags":["payments"],"parameters":[{"name":"include","in":"query","required":false,"description":"Include related entities in the response. Use a comma-separated list to specify multiple entities.","schema":{"type":"array","description":"Include related entities in the response. Use a comma-separated list to specify multiple entities."}},{"name":"transaction_id","in":"query","required":true,"description":"Paddle ID of the transaction entity to work with.","schema":{"type":"string","description":"Paddle ID of the transaction entity to work with."}}],"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/payments:paddle/update-transaction":{"post":{"operationId":"payments_paddle_update_transaction","summary":"Update a transaction","description":"PATCH /transactions/{transaction_id}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["transaction_id","body"],"properties":{"include":{"type":"array","description":"Include related entities in the response. Use a comma-separated list to specify multiple entities."},"transaction_id":{"type":"string","description":"Paddle ID of the transaction entity to work with."},"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/payments:paddle/preview-transaction-create":{"post":{"operationId":"payments_paddle_preview_transaction_create","summary":"Preview a transaction","description":"POST /transactions/preview","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/payments:paddle/revise-transaction":{"post":{"operationId":"payments_paddle_revise_transaction","summary":"Revise customer information on a billed or completed transaction","description":"POST /transactions/{transaction_id}/revise","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["transaction_id","body"],"properties":{"transaction_id":{"type":"string","description":"Paddle ID of the transaction entity to work with."},"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/payments:paddle/get-transaction-invoice":{"get":{"operationId":"payments_paddle_get_transaction_invoice","summary":"Get a PDF invoice for a transaction","description":"GET /transactions/{transaction_id}/invoice","tags":["payments"],"parameters":[{"name":"transaction_id","in":"query","required":true,"description":"Paddle ID of the transaction entity to work with.","schema":{"type":"string","description":"Paddle ID of the transaction entity to work with."}},{"name":"disposition","in":"query","required":false,"description":"Determine whether the generated URL should download the PDF as an attachment saved locally, or open it inline in the browser. Default:…","schema":{"type":"string","enum":["attachment","inline"],"description":"Determine whether the generated URL should download the PDF as an attachment saved locally, or open it inline in the browser. Default:…"}}],"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/payments:paddle/list-verifications":{"get":{"operationId":"payments_paddle_list_verifications","summary":"List verifications","description":"GET /verifications","tags":["payments"],"parameters":[{"name":"id","in":"query","required":false,"description":"Return only the IDs specified. Use a comma-separated list to get multiple entities.","schema":{"type":"array","description":"Return only the IDs specified. Use a comma-separated list to get multiple entities."}},{"name":"after","in":"query","required":false,"description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…","schema":{"type":"string","description":"Return entities after the specified Paddle ID when working with paginated endpoints. Used in the `meta.pagination.next` URL in responses…"}},{"name":"per_page","in":"query","required":false,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…","schema":{"type":"integer","default":50,"description":"Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is…"}},{"name":"verification_type","in":"query","required":false,"description":"Filter verifications by type. If omitted, verifications of all types are returned.","schema":{"type":"string","enum":["onboarding","domain"],"description":"Filter verifications by type. If omitted, verifications of all types are returned."}},{"name":"order_by","in":"query","required":false,"description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…","schema":{"type":"string","default":"id[DESC]","description":"Order returned entities by the specified field and direction (`[ASC]` or `[DESC]`). For example, `?order_by=id[ASC]`. Valid fields for…"}},{"name":"Skip-Count","in":"query","required":false,"description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…","schema":{"type":"string","description":"Set to `true` to skip the count query on list operations. When set, `meta.pagination.estimated_total` returns `-1` instead of an exact…"}}],"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/payments:paddle/get-verification":{"get":{"operationId":"payments_paddle_get_verification","summary":"Get a verification","description":"GET /verifications/{verification_id}","tags":["payments"],"parameters":[{"name":"verification_id","in":"query","required":true,"description":"Unique Paddle ID for this verification entity, prefixed with `slrvrf_`.","schema":{"type":"string","description":"Unique Paddle ID for this verification entity, prefixed with `slrvrf_`."}}],"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"}}},"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"}}}}}}}