From 9388dbdf93875a3ee71812f60a9a84c4e03f9c9b Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Thu, 26 Mar 2026 00:26:58 +0000 Subject: [PATCH 1/2] ## Python SDK Changes Detected: * `polar._endpointcheckout_created_post()`: * `request.data` **Changed** **Breaking** :warning: * `polar._endpointcheckout_updated_post()`: * `request.data` **Changed** **Breaking** :warning: * `polar._endpointcheckout_expired_post()`: * `request.data` **Changed** **Breaking** :warning: * `polar._endpointsubscription_created_post()`: * `request.data` **Changed** **Breaking** :warning: * `polar._endpointsubscription_updated_post()`: * `request.data` **Changed** **Breaking** :warning: * `polar._endpointsubscription_active_post()`: * `request.data` **Changed** **Breaking** :warning: * `polar._endpointsubscription_canceled_post()`: * `request.data` **Changed** **Breaking** :warning: * `polar._endpointsubscription_uncanceled_post()`: * `request.data` **Changed** **Breaking** :warning: * `polar._endpointsubscription_revoked_post()`: * `request.data` **Changed** **Breaking** :warning: * `polar._endpointsubscription_past_due_post()`: * `request.data` **Changed** **Breaking** :warning: * `polar._endpointproduct_created_post()`: * `request.data.prices.[]` **Changed** **Breaking** :warning: * `polar._endpointproduct_updated_post()`: * `request.data.prices.[]` **Changed** **Breaking** :warning: * `polar._endpointorganization_updated_post()`: * `request.data` **Changed** **Breaking** :warning: * `polar.checkouts.client_confirm()`: `response` **Changed** **Breaking** :warning: * `polar.organizations.create()`: * `request` **Changed** **Breaking** :warning: * `response` **Changed** * `polar.checkouts.client_update()`: `response` **Changed** **Breaking** :warning: * `polar.organizations.update()`: * `request.organization_update` **Changed** **Breaking** :warning: * `response` **Changed** * `polar.checkouts.client_get()`: `response` **Changed** **Breaking** :warning: * `polar.checkouts.update()`: `response` **Changed** **Breaking** :warning: * `polar.checkouts.get()`: `response` **Changed** **Breaking** :warning: * `polar.checkouts.create()`: * `request.prices.{}.[]` **Changed** * `response` **Changed** **Breaking** :warning: * `polar.checkouts.list()`: `response.items.[]` **Changed** **Breaking** :warning: * `polar.products.get()`: `response.prices.[]` **Changed** * `polar.checkout-links.create()`: `response.products.[].prices.[]` **Changed** * `polar.products.list()`: `response.items.[].prices.[]` **Changed** * `polar.products.update()`: * `request.product_update.prices.[].[2]` **Changed** * `response.prices.[]` **Changed** * `polar.products.update_benefits()`: `response.prices.[]` **Changed** * `polar.subscriptions.update()`: * `response` **Changed** * `error.status[402]` **Added** * `polar.subscriptions.revoke()`: `response` **Changed** * `polar.subscriptions.get()`: `response` **Changed** * `polar.subscriptions.create()`: `response` **Changed** * `polar.subscriptions.list()`: `response.items.[]` **Changed** * `polar.organizations.get()`: `response` **Changed** * `polar.organizations.list()`: `response.items.[]` **Changed** * `polar.checkout-links.list()`: `response.items.[].products.[].prices.[]` **Changed** * `polar.products.create()`: * `request.[product_create_recurring].prices.[]` **Changed** * `response.prices.[]` **Changed** * `polar.checkout-links.get()`: `response.products.[].prices.[]` **Changed** * `polar.checkout-links.update()`: `response.products.[].prices.[]` **Changed** * `polar.members.list_members()`: `request.role` **Added** * `polar.customer_portal.seats.list_claimed_subscriptions()`: `response.items.[]` **Changed** * `polar.customer_portal.orders.list()`: `response.items.[].product.prices.[]` **Changed** * `polar.customer_portal.orders.get()`: `response.product.prices.[]` **Changed** * `polar.customer_portal.orders.update()`: `response.product.prices.[]` **Changed** * `polar.customer_portal.organizations.get()`: `response.products.[].prices.[]` **Changed** * `polar.customer_portal.subscriptions.list()`: `response.items.[]` **Changed** * `polar.customer_portal.subscriptions.get()`: `response` **Changed** * `polar.customer_portal.subscriptions.cancel()`: `response` **Changed** * `polar.customer_portal.subscriptions.update()`: * `response` **Changed** * `error.status[402]` **Added** --- .speakeasy/gen.lock | 366 ++++++++++-------- .speakeasy/gen.yaml | 2 +- .speakeasy/workflow.lock | 12 +- README.md | 3 +- RELEASES.md | 12 +- codeSamples.yaml | 64 +-- docs/models/address.md | 16 +- docs/models/addresscountryalpha2.md | 256 ++++++++++++ docs/models/addressinput.md | 16 +- docs/models/addressinputcountryalpha2input.md | 251 ++++++++++++ docs/models/checkout.md | 1 - docs/models/checkoutpublic.md | 1 - docs/models/checkoutpublicconfirmed.md | 1 - docs/models/countrycountryalpha2input.md | 251 ++++++++++++ docs/models/customersubscription.md | 3 +- .../legacyrecurringproductpricecustom.md | 1 + .../legacyrecurringproductpricefixed.md | 29 +- .../models/legacyrecurringproductpricefree.md | 27 +- docs/models/legalentity.md | 17 + docs/models/memberslistmembersrequest.md | 1 + docs/models/metricperiod.md | 2 +- docs/models/metrics.md | 2 +- docs/models/metricstotals.md | 2 +- docs/models/organization.md | 6 +- .../organizationcompanylegalentityschema.md | 9 + docs/models/organizationcreate.md | 5 +- .../organizationcustomeremailsettings.md | 24 +- docs/models/organizationdetails.md | 22 +- ...organizationindividuallegalentityschema.md | 8 + docs/models/organizationupdate.md | 4 +- docs/models/paymentfailed.md | 9 + docs/models/pendingsubscriptionupdate.md | 15 + docs/models/presentmentcurrency.md | 30 +- docs/models/productpricecustom.md | 1 + docs/models/productpricecustomcreate.md | 1 + docs/models/productpricefixed.md | 23 +- docs/models/productpricefixedcreate.md | 11 +- docs/models/productpricefree.md | 21 +- docs/models/productpricefreecreate.md | 9 +- docs/models/productpricemeteredunit.md | 29 +- docs/models/productpricemeteredunitcreate.md | 15 +- docs/models/productpriceseatbased.md | 1 + docs/models/productpriceseatbasedcreate.md | 1 + docs/models/productpriceseattiersinput.md | 1 + docs/models/productpriceseattiersoutput.md | 1 + docs/models/seatassign.md | 24 +- docs/models/seattiertype.md | 9 + docs/models/subscription.md | 3 +- docs/models/taxbehavioroption.md | 10 + docs/sdks/checkouts/README.md | 6 +- docs/sdks/customers/README.md | 4 +- docs/sdks/members/README.md | 1 + docs/sdks/orders/README.md | 2 +- docs/sdks/polarcustomers/README.md | 2 +- docs/sdks/polarorders/README.md | 2 +- docs/sdks/polarsubscriptions/README.md | 1 + docs/sdks/subscriptions/README.md | 1 + pyproject.toml | 2 +- src/polar_sdk/_version.py | 4 +- src/polar_sdk/members.py | 8 + src/polar_sdk/models/__init__.py | 73 +++- src/polar_sdk/models/address.py | 6 +- src/polar_sdk/models/addressinput.py | 6 +- src/polar_sdk/models/checkout.py | 7 - src/polar_sdk/models/checkoutpublic.py | 7 - .../models/checkoutpublicconfirmed.py | 7 - src/polar_sdk/models/customersubscription.py | 10 + .../legacyrecurringproductpricecustom.py | 13 +- .../legacyrecurringproductpricefixed.py | 8 +- .../models/legacyrecurringproductpricefree.py | 8 +- .../models/members_list_membersop.py | 12 +- src/polar_sdk/models/metricperiod.py | 22 +- src/polar_sdk/models/metrics.py | 10 +- src/polar_sdk/models/metricstotals.py | 26 +- src/polar_sdk/models/organization.py | 273 ++++++++++++- .../organizationcompanylegalentityschema.py | 23 ++ src/polar_sdk/models/organizationcreate.py | 298 +++++++++++++- .../organizationcustomeremailsettings.py | 6 + src/polar_sdk/models/organizationdetails.py | 86 +++- ...organizationindividuallegalentityschema.py | 20 + src/polar_sdk/models/organizationupdate.py | 263 +++++++++++++ src/polar_sdk/models/paymentfailed.py | 38 ++ .../models/pendingsubscriptionupdate.py | 76 ++++ src/polar_sdk/models/presentmentcurrency.py | 28 +- src/polar_sdk/models/productpricecustom.py | 13 +- .../models/productpricecustomcreate.py | 9 +- src/polar_sdk/models/productpricefixed.py | 8 +- .../models/productpricefixedcreate.py | 109 +++++- src/polar_sdk/models/productpricefree.py | 8 +- .../models/productpricefreecreate.py | 39 +- .../models/productpricemeteredunit.py | 8 +- .../models/productpricemeteredunitcreate.py | 10 +- src/polar_sdk/models/productpriceseatbased.py | 8 +- .../models/productpriceseatbasedcreate.py | 39 +- .../models/productpriceseattiers_input.py | 8 +- .../models/productpriceseattiers_output.py | 10 +- src/polar_sdk/models/seatassign.py | 8 +- src/polar_sdk/models/seattiertype.py | 9 + src/polar_sdk/models/subscription.py | 10 + src/polar_sdk/models/taxbehavioroption.py | 10 + src/polar_sdk/polar_subscriptions.py | 10 +- src/polar_sdk/subscriptions.py | 10 +- 102 files changed, 2845 insertions(+), 468 deletions(-) create mode 100644 docs/models/addresscountryalpha2.md create mode 100644 docs/models/addressinputcountryalpha2input.md create mode 100644 docs/models/countrycountryalpha2input.md create mode 100644 docs/models/legalentity.md create mode 100644 docs/models/organizationcompanylegalentityschema.md create mode 100644 docs/models/organizationindividuallegalentityschema.md create mode 100644 docs/models/paymentfailed.md create mode 100644 docs/models/pendingsubscriptionupdate.md create mode 100644 docs/models/seattiertype.md create mode 100644 docs/models/taxbehavioroption.md create mode 100644 src/polar_sdk/models/organizationcompanylegalentityschema.py create mode 100644 src/polar_sdk/models/organizationindividuallegalentityschema.py create mode 100644 src/polar_sdk/models/paymentfailed.py create mode 100644 src/polar_sdk/models/pendingsubscriptionupdate.py create mode 100644 src/polar_sdk/models/seattiertype.py create mode 100644 src/polar_sdk/models/taxbehavioroption.py diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index dd549361..3d93d909 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: e7042734-e669-4c36-85da-bbb4a7500ac8 management: - docChecksum: 62d3530bddac85d2bb1c8b53301ba781 + docChecksum: 3daf94fecbceadc93fcf32b748558822 docVersion: 0.1.0 speakeasyVersion: 1.648.0 generationVersion: 2.737.0 - releaseVersion: 0.30.1 - configChecksum: 535486efaca9ec378c33ef11821fda62 + releaseVersion: 0.30.2 + configChecksum: 05fa919479d611801ae8ec1beea06610 repoURL: https://github.com/polarsource/polar-python.git installationURL: https://github.com/polarsource/polar-python.git published: true @@ -51,8 +51,10 @@ generatedFiles: - docs/models/activesubscriptions.md - docs/models/activeuserbyevent.md - docs/models/address.md + - docs/models/addresscountryalpha2.md - docs/models/addressdict.md - docs/models/addressinput.md + - docs/models/addressinputcountryalpha2input.md - docs/models/aggregation.md - docs/models/aggregationfunction.md - docs/models/alreadyactivesubscriptionerror.md @@ -292,6 +294,7 @@ generatedFiles: - docs/models/countaggregation.md - docs/models/countryalpha2.md - docs/models/countryalpha2input.md + - docs/models/countrycountryalpha2input.md - docs/models/cumulativecosts.md - docs/models/cumulativerevenue.md - docs/models/cursorpagination.md @@ -665,6 +668,7 @@ generatedFiles: - docs/models/legacyrecurringproductpricecustom.md - docs/models/legacyrecurringproductpricefixed.md - docs/models/legacyrecurringproductpricefree.md + - docs/models/legalentity.md - docs/models/licensekeyactivate.md - docs/models/licensekeyactivateconditions.md - docs/models/licensekeyactivatemeta.md @@ -891,6 +895,7 @@ generatedFiles: - docs/models/organizationaccesstokenupdate.md - docs/models/organizationavatarfilecreate.md - docs/models/organizationavatarfileread.md + - docs/models/organizationcompanylegalentityschema.md - docs/models/organizationcreate.md - docs/models/organizationcustomeremailsettings.md - docs/models/organizationcustomerportalsettings.md @@ -898,6 +903,7 @@ generatedFiles: - docs/models/organizationfeaturesettings.md - docs/models/organizationid.md - docs/models/organizationidfilter.md + - docs/models/organizationindividuallegalentityschema.md - docs/models/organizationnotificationsettings.md - docs/models/organizationsgetrequest.md - docs/models/organizationslistrequest.md @@ -914,6 +920,7 @@ generatedFiles: - docs/models/payment.md - docs/models/paymentalreadyinprogress.md - docs/models/paymenterror.md + - docs/models/paymentfailed.md - docs/models/paymentmethodcard.md - docs/models/paymentmethodcardmetadata.md - docs/models/paymentmethodgeneric.md @@ -929,6 +936,7 @@ generatedFiles: - docs/models/paymentslistresponse.md - docs/models/paymentsortproperty.md - docs/models/paymentstatus.md + - docs/models/pendingsubscriptionupdate.md - docs/models/permission.md - docs/models/portalauthenticateduser.md - docs/models/presentmentcurrency.md @@ -1027,6 +1035,7 @@ generatedFiles: - docs/models/seatclaiminfo.md - docs/models/seatslist.md - docs/models/seatstatus.md + - docs/models/seattiertype.md - docs/models/security.md - docs/models/sourcefilter.md - docs/models/status.md @@ -1088,6 +1097,7 @@ generatedFiles: - docs/models/succeededcheckouts.md - docs/models/switchingfrom.md - docs/models/systemevent.md + - docs/models/taxbehavioroption.md - docs/models/taxid.md - docs/models/taxidformat.md - docs/models/timeframe.md @@ -1764,11 +1774,13 @@ generatedFiles: - src/polar_sdk/models/organizationaccesstokenupdate.py - src/polar_sdk/models/organizationavatarfilecreate.py - src/polar_sdk/models/organizationavatarfileread.py + - src/polar_sdk/models/organizationcompanylegalentityschema.py - src/polar_sdk/models/organizationcreate.py - src/polar_sdk/models/organizationcustomeremailsettings.py - src/polar_sdk/models/organizationcustomerportalsettings.py - src/polar_sdk/models/organizationdetails.py - src/polar_sdk/models/organizationfeaturesettings.py + - src/polar_sdk/models/organizationindividuallegalentityschema.py - src/polar_sdk/models/organizationnotificationsettings.py - src/polar_sdk/models/organizations_getop.py - src/polar_sdk/models/organizations_listop.py @@ -1784,6 +1796,7 @@ generatedFiles: - src/polar_sdk/models/payment.py - src/polar_sdk/models/paymentalreadyinprogress.py - src/polar_sdk/models/paymenterror.py + - src/polar_sdk/models/paymentfailed.py - src/polar_sdk/models/paymentmethodcard.py - src/polar_sdk/models/paymentmethodcardmetadata.py - src/polar_sdk/models/paymentmethodgeneric.py @@ -1794,6 +1807,7 @@ generatedFiles: - src/polar_sdk/models/payments_listop.py - src/polar_sdk/models/paymentsortproperty.py - src/polar_sdk/models/paymentstatus.py + - src/polar_sdk/models/pendingsubscriptionupdate.py - src/polar_sdk/models/polarerror.py - src/polar_sdk/models/portalauthenticateduser.py - src/polar_sdk/models/presentmentcurrency.py @@ -1854,6 +1868,7 @@ generatedFiles: - src/polar_sdk/models/seatclaiminfo.py - src/polar_sdk/models/seatslist.py - src/polar_sdk/models/seatstatus.py + - src/polar_sdk/models/seattiertype.py - src/polar_sdk/models/security.py - src/polar_sdk/models/subscription.py - src/polar_sdk/models/subscriptionbillingperiodupdatedevent.py @@ -1903,6 +1918,7 @@ generatedFiles: - src/polar_sdk/models/subscriptionupdatetrial.py - src/polar_sdk/models/subtype.py - src/polar_sdk/models/systemevent.py + - src/polar_sdk/models/taxbehavioroption.py - src/polar_sdk/models/taxidformat.py - src/polar_sdk/models/timeinterval.py - src/polar_sdk/models/tokenresponse.py @@ -2010,7 +2026,7 @@ examples: _endpointcheckout_created_post: speakeasy-default-endpointcheckout-created-post: requestBody: - application/json: {"type": "checkout.created", "timestamp": "2023-02-15T15:44:21.478Z", "data": {"id": "", "created_at": "2023-02-15T15:44:21.478Z", "modified_at": "2023-09-13T08:36:46.434Z", "payment_processor": "stripe", "status": "expired", "client_secret": "", "url": "https://whole-aftermath.net/", "expires_at": "2023-12-28T10:30:56.042Z", "success_url": "https://moral-premier.name/", "return_url": null, "embed_origin": "", "amount": 929514, "discount_amount": 323773, "net_amount": 115799, "tax_amount": 97012, "total_amount": 859980, "currency": "Fiji Dollar", "allow_trial": null, "active_trial_interval": null, "active_trial_interval_count": 232991, "trial_end": "2023-10-05T12:55:46.428Z", "organization_id": "", "product_id": "", "product_price_id": null, "discount_id": null, "allow_discount_codes": true, "require_billing_address": true, "is_discount_applicable": true, "is_free_product_price": true, "is_payment_required": true, "is_payment_setup_required": true, "is_payment_form_required": true, "customer_id": "", "is_business_customer": false, "customer_name": "", "customer_email": null, "customer_ip_address": null, "customer_billing_name": "", "customer_billing_address": {"country": "US"}, "customer_tax_id": "", "payment_processor_metadata": {"key": "", "key1": "", "key2": ""}, "billing_address_fields": {"country": "required", "state": "disabled", "city": "required", "postal_code": "required", "line1": "required", "line2": "disabled"}, "trial_interval": "day", "trial_interval_count": 329779, "metadata": {"key": false, "key1": false}, "external_customer_id": null, "products": [{"id": "", "created_at": "2025-07-23T17:21:51.405Z", "modified_at": "2024-01-17T03:32:08.030Z", "trial_interval": "month", "trial_interval_count": 631188, "name": "", "description": "funny abscond fairly except slight", "visibility": "draft", "recurring_interval": null, "recurring_interval_count": null, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2023-09-13T08:36:46.434Z", "modified_at": "2023-10-05T12:55:46.428Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/var/log", "mime_type": "", "size": 982910, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-09-13T03:57:17.676Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-03-23T06:47:50.944Z", "size_readable": "", "public_url": "https://yummy-ocelot.biz/"}, {"id": "", "organization_id": "", "name": "", "path": "/var/log", "mime_type": "", "size": 982910, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-09-13T03:57:17.676Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-03-23T06:47:50.944Z", "size_readable": "", "public_url": "https://yummy-ocelot.biz/"}, {"id": "", "organization_id": "", "name": "", "path": "/var/log", "mime_type": "", "size": 982910, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-09-13T03:57:17.676Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-03-23T06:47:50.944Z", "size_readable": "", "public_url": "https://yummy-ocelot.biz/"}]}], "product": {"id": "", "created_at": "2023-03-01T03:35:30.257Z", "modified_at": "2024-12-19T15:40:11.887Z", "trial_interval": "year", "trial_interval_count": 115799, "name": "", "description": "until joyful how", "visibility": "public", "recurring_interval": "month", "recurring_interval_count": 232991, "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2024-05-02T18:25:33.974Z", "modified_at": "2025-02-06T12:55:07.640Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 115799, "legacy": true}, {"created_at": "2025-07-31T12:54:47.590Z", "modified_at": "2023-01-11T22:31:47.320Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 203013, "maximum_amount": null, "preset_amount": 119260, "legacy": true}, {"created_at": "2024-04-06T18:48:21.449Z", "modified_at": null, "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}], "benefits": [{"id": "", "created_at": "2023-11-22T11:07:53.319Z", "modified_at": "2025-09-17T18:38:51.288Z", "type": "discord", "description": "brr now psst", "selectable": true, "deletable": true, "organization_id": ""}, {"id": "", "created_at": "2023-11-22T11:07:53.319Z", "modified_at": "2025-09-17T18:38:51.288Z", "type": "discord", "description": "brr now psst", "selectable": true, "deletable": true, "organization_id": ""}], "medias": []}, "product_price": {"created_at": "2024-10-04T12:55:46.428Z", "modified_at": "2024-01-21T19:51:40.643Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "week", "minimum_amount": 527093, "maximum_amount": 631188, "preset_amount": 929514, "legacy": true}, "prices": null, "discount": {"duration": "repeating", "duration_in_months": 470604, "type": "fixed", "basis_points": 567071, "id": "", "name": "", "code": ""}, "subscription_id": "", "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-01-27T12:44:05.844Z", "modified_at": "2023-11-12T13:10:44.040Z", "id": "", "metadata": {"key": 833527, "key1": false}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 786803, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2024-01-27T12:44:05.844Z", "modified_at": "2023-11-12T13:10:44.040Z", "id": "", "metadata": {"key": 833527, "key1": false}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 786803, "required": false}], "customer_metadata": {}}} + application/json: {"type": "checkout.created", "timestamp": "2023-02-15T15:44:21.478Z", "data": {"id": "", "created_at": "2023-02-15T15:44:21.478Z", "modified_at": "2023-09-13T08:36:46.434Z", "payment_processor": "stripe", "status": "expired", "client_secret": "", "url": "https://whole-aftermath.net/", "expires_at": "2023-12-28T10:30:56.042Z", "success_url": "https://moral-premier.name/", "return_url": null, "embed_origin": "", "amount": 929514, "discount_amount": 323773, "net_amount": 115799, "tax_amount": 97012, "total_amount": 859980, "currency": "Fiji Dollar", "allow_trial": null, "active_trial_interval": null, "active_trial_interval_count": 232991, "trial_end": "2023-10-05T12:55:46.428Z", "organization_id": "", "product_id": "", "product_price_id": null, "discount_id": null, "allow_discount_codes": true, "require_billing_address": true, "is_discount_applicable": true, "is_free_product_price": true, "is_payment_required": true, "is_payment_setup_required": true, "is_payment_form_required": true, "customer_id": "", "is_business_customer": false, "customer_name": "", "customer_email": null, "customer_ip_address": null, "customer_billing_name": "", "customer_billing_address": {"country": "US"}, "customer_tax_id": "", "payment_processor_metadata": {"key": "", "key1": "", "key2": ""}, "billing_address_fields": {"country": "required", "state": "disabled", "city": "required", "postal_code": "required", "line1": "required", "line2": "disabled"}, "trial_interval": "day", "trial_interval_count": 329779, "metadata": {"key": false, "key1": false}, "external_customer_id": null, "products": [{"id": "", "created_at": "2025-07-23T17:21:51.405Z", "modified_at": "2024-01-17T03:32:08.030Z", "trial_interval": "month", "trial_interval_count": 631188, "name": "", "description": "funny abscond fairly except slight", "visibility": "draft", "recurring_interval": null, "recurring_interval_count": null, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2023-09-13T08:36:46.434Z", "modified_at": "2023-10-05T12:55:46.428Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "tax_behavior": null, "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/var/log", "mime_type": "", "size": 982910, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-09-13T03:57:17.676Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-03-23T06:47:50.944Z", "size_readable": "", "public_url": "https://yummy-ocelot.biz/"}, {"id": "", "organization_id": "", "name": "", "path": "/var/log", "mime_type": "", "size": 982910, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-09-13T03:57:17.676Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-03-23T06:47:50.944Z", "size_readable": "", "public_url": "https://yummy-ocelot.biz/"}, {"id": "", "organization_id": "", "name": "", "path": "/var/log", "mime_type": "", "size": 982910, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-09-13T03:57:17.676Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-03-23T06:47:50.944Z", "size_readable": "", "public_url": "https://yummy-ocelot.biz/"}]}], "product": {"id": "", "created_at": "2023-03-01T03:35:30.257Z", "modified_at": "2024-12-19T15:40:11.887Z", "trial_interval": "year", "trial_interval_count": 115799, "name": "", "description": "until joyful how", "visibility": "public", "recurring_interval": "month", "recurring_interval_count": 232991, "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2024-05-02T18:25:33.974Z", "modified_at": "2025-02-06T12:55:07.640Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "location", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 115799, "legacy": true}, {"created_at": "2025-07-31T12:54:47.590Z", "modified_at": "2023-01-11T22:31:47.320Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 203013, "maximum_amount": null, "preset_amount": 119260, "legacy": true}, {"created_at": "2024-04-06T18:48:21.449Z", "modified_at": null, "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}], "benefits": [{"id": "", "created_at": "2023-11-22T11:07:53.319Z", "modified_at": "2025-09-17T18:38:51.288Z", "type": "discord", "description": "brr now psst", "selectable": true, "deletable": true, "organization_id": ""}, {"id": "", "created_at": "2023-11-22T11:07:53.319Z", "modified_at": "2025-09-17T18:38:51.288Z", "type": "discord", "description": "brr now psst", "selectable": true, "deletable": true, "organization_id": ""}], "medias": []}, "product_price": {"created_at": "2024-10-04T12:55:46.428Z", "modified_at": "2024-01-21T19:51:40.643Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "week", "minimum_amount": 527093, "maximum_amount": 631188, "preset_amount": 929514, "legacy": true}, "prices": null, "discount": {"duration": "repeating", "duration_in_months": 470604, "type": "fixed", "basis_points": 567071, "id": "", "name": "", "code": ""}, "subscription_id": "", "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-01-27T12:44:05.844Z", "modified_at": "2023-11-12T13:10:44.040Z", "id": "", "metadata": {"key": 833527, "key1": false}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 786803, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2024-01-27T12:44:05.844Z", "modified_at": "2023-11-12T13:10:44.040Z", "id": "", "metadata": {"key": 833527, "key1": false}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 786803, "required": false}], "customer_metadata": {}}} responses: "200": application/json: "" @@ -2019,7 +2035,7 @@ examples: _endpointcheckout_updated_post: speakeasy-default-endpointcheckout-updated-post: requestBody: - application/json: {"type": "checkout.updated", "timestamp": "2023-03-19T05:40:46.816Z", "data": {"id": "", "created_at": "2023-03-19T05:40:46.816Z", "modified_at": "2025-01-17T21:45:54.449Z", "payment_processor": "stripe", "status": "succeeded", "client_secret": "", "url": "https://wasteful-kinase.net/", "expires_at": "2024-07-13T07:40:45.762Z", "success_url": "https://unwieldy-lift.name", "return_url": null, "embed_origin": "", "amount": 328864, "discount_amount": 67168, "net_amount": 710560, "tax_amount": 164230, "total_amount": 754328, "currency": "New Taiwan Dollar", "allow_trial": null, "active_trial_interval": null, "active_trial_interval_count": 682397, "trial_end": "2024-01-01T01:21:07.047Z", "organization_id": "", "product_id": "", "product_price_id": null, "discount_id": "", "allow_discount_codes": true, "require_billing_address": true, "is_discount_applicable": true, "is_free_product_price": true, "is_payment_required": true, "is_payment_setup_required": false, "is_payment_form_required": true, "customer_id": null, "is_business_customer": false, "customer_name": "", "customer_email": "", "customer_ip_address": "", "customer_billing_name": "", "customer_billing_address": {"country": "US"}, "customer_tax_id": "", "payment_processor_metadata": {}, "billing_address_fields": {"country": "required", "state": "optional", "city": "disabled", "postal_code": "optional", "line1": "required", "line2": "disabled"}, "trial_interval": "week", "trial_interval_count": 510328, "metadata": {"key": 8729.81, "key1": "", "key2": 302746}, "external_customer_id": null, "products": [{"id": "", "created_at": "2024-02-06T13:10:07.718Z", "modified_at": "2025-05-28T09:18:17.409Z", "trial_interval": "year", "trial_interval_count": 558100, "name": "", "description": "gee unlike aboard entice which break", "visibility": "draft", "recurring_interval": "month", "recurring_interval_count": null, "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2025-01-17T21:45:54.449Z", "modified_at": "2024-01-01T01:21:07.047Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 720125, "legacy": true}, {"created_at": "2025-09-27T00:00:25.178Z", "modified_at": "2024-09-03T16:16:06.332Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}], "benefits": [{"id": "", "created_at": "2025-07-05T15:21:14.498Z", "modified_at": "2023-11-21T02:59:50.838Z", "type": "downloadables", "description": "highlight sandy overspend scratchy yet by", "selectable": true, "deletable": false, "organization_id": ""}], "medias": []}, {"id": "", "created_at": "2024-02-06T13:10:07.718Z", "modified_at": "2025-05-28T09:18:17.409Z", "trial_interval": "week", "trial_interval_count": null, "name": "", "description": "gee unlike aboard entice which break", "visibility": "private", "recurring_interval": "month", "recurring_interval_count": 682397, "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2023-06-29T23:54:25.932Z", "modified_at": "2025-08-08T18:57:45.007Z", "id": "", "source": "ad_hoc", "amount_type": "metered_unit", "price_currency": "", "is_archived": true, "product_id": "", "unit_amount": "", "cap_amount": null, "meter_id": "", "meter": {"id": "", "name": ""}}, {"created_at": "2024-04-12T18:30:19.906Z", "modified_at": null, "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}], "benefits": [{"id": "", "created_at": "2025-07-05T15:21:14.498Z", "modified_at": "2023-11-21T02:59:50.838Z", "type": "downloadables", "description": "highlight sandy overspend scratchy yet by", "selectable": true, "deletable": false, "organization_id": ""}], "medias": []}, {"id": "", "created_at": "2024-02-06T13:10:07.718Z", "modified_at": "2025-05-28T09:18:17.409Z", "trial_interval": "year", "trial_interval_count": 754328, "name": "", "description": "gee unlike aboard entice which break", "visibility": "public", "recurring_interval": "month", "recurring_interval_count": 333080, "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2025-04-08T09:51:58.249Z", "modified_at": "2025-07-16T15:01:26.410Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2023-11-28T19:26:30.837Z", "modified_at": "2025-10-14T04:57:44.285Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 801449, "legacy": true}], "benefits": [{"id": "", "created_at": "2025-07-05T15:21:14.498Z", "modified_at": "2023-11-21T02:59:50.838Z", "type": "downloadables", "description": "highlight sandy overspend scratchy yet by", "selectable": true, "deletable": false, "organization_id": ""}], "medias": []}], "product": {"id": "", "created_at": "2024-04-04T09:43:29.328Z", "modified_at": "2024-01-03T07:24:30.583Z", "trial_interval": "week", "trial_interval_count": 140837, "name": "", "description": "patroller fax sadly sick bitterly indeed grandson bravely loyally wholly", "visibility": "private", "recurring_interval": "month", "recurring_interval_count": 496454, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2025-11-27T17:16:31.119Z", "modified_at": "2025-06-04T15:43:18.802Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 72487, "legacy": true}, {"created_at": "2024-06-14T15:19:42.985Z", "modified_at": "2025-08-21T13:42:50.786Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}, {"created_at": "2025-02-06T04:48:01.265Z", "modified_at": "2024-01-15T02:31:30.334Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 849243, "maximum_amount": 295343, "preset_amount": 994380, "legacy": true}], "benefits": [{"id": "", "created_at": "2025-07-05T15:21:14.498Z", "modified_at": "2023-11-21T02:59:50.838Z", "type": "downloadables", "description": "highlight sandy overspend scratchy yet by", "selectable": true, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/opt", "mime_type": "", "size": 349206, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-11-20T22:00:21.061Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-10-01T19:20:04.513Z", "size_readable": "", "public_url": "https://noted-availability.info"}, {"id": "", "organization_id": "", "name": "", "path": "/opt", "mime_type": "", "size": 349206, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-11-20T22:00:21.061Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-10-01T19:20:04.513Z", "size_readable": "", "public_url": "https://noted-availability.info"}, {"id": "", "organization_id": "", "name": "", "path": "/opt", "mime_type": "", "size": 349206, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-11-20T22:00:21.061Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-10-01T19:20:04.513Z", "size_readable": "", "public_url": "https://noted-availability.info"}]}, "product_price": {"created_at": "2024-12-31T01:21:07.047Z", "modified_at": "2025-06-28T02:43:46.293Z", "id": "", "source": "ad_hoc", "amount_type": "metered_unit", "price_currency": "", "is_archived": false, "product_id": "", "unit_amount": "", "cap_amount": 912409, "meter_id": "", "meter": {"id": "", "name": ""}}, "prices": {"key": [], "key1": []}, "discount": {"duration": "once", "duration_in_months": 187379, "type": "fixed", "basis_points": 373595, "id": "", "name": "", "code": ""}, "subscription_id": "", "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-09-18T09:12:02.157Z", "modified_at": "2023-07-11T01:18:07.226Z", "id": "", "metadata": {"key": ""}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 704552, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2024-09-18T09:12:02.157Z", "modified_at": "2023-07-11T01:18:07.226Z", "id": "", "metadata": {"key": ""}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 704552, "required": true}], "customer_metadata": {"key": 384374, "key1": 126671, "key2": 568803}}} + application/json: {"type": "checkout.updated", "timestamp": "2023-03-19T05:40:46.816Z", "data": {"id": "", "created_at": "2023-03-19T05:40:46.816Z", "modified_at": "2025-01-17T21:45:54.449Z", "payment_processor": "stripe", "status": "succeeded", "client_secret": "", "url": "https://wasteful-kinase.net/", "expires_at": "2024-07-13T07:40:45.762Z", "success_url": "https://unwieldy-lift.name", "return_url": null, "embed_origin": "", "amount": 328864, "discount_amount": 67168, "net_amount": 710560, "tax_amount": 164230, "total_amount": 754328, "currency": "New Taiwan Dollar", "allow_trial": null, "active_trial_interval": null, "active_trial_interval_count": 682397, "trial_end": "2024-01-01T01:21:07.047Z", "organization_id": "", "product_id": "", "product_price_id": null, "discount_id": "", "allow_discount_codes": true, "require_billing_address": true, "is_discount_applicable": true, "is_free_product_price": true, "is_payment_required": true, "is_payment_setup_required": false, "is_payment_form_required": true, "customer_id": null, "is_business_customer": false, "customer_name": "", "customer_email": "", "customer_ip_address": "", "customer_billing_name": "", "customer_billing_address": {"country": "US"}, "customer_tax_id": "", "payment_processor_metadata": {}, "billing_address_fields": {"country": "required", "state": "optional", "city": "disabled", "postal_code": "optional", "line1": "required", "line2": "disabled"}, "trial_interval": "week", "trial_interval_count": 510328, "metadata": {"key": 8729.81, "key1": "", "key2": 302746}, "external_customer_id": null, "products": [{"id": "", "created_at": "2024-02-06T13:10:07.718Z", "modified_at": "2025-05-28T09:18:17.409Z", "trial_interval": "year", "trial_interval_count": 558100, "name": "", "description": "gee unlike aboard entice which break", "visibility": "draft", "recurring_interval": "month", "recurring_interval_count": null, "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2025-01-17T21:45:54.449Z", "modified_at": "2024-01-01T01:21:07.047Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "tax_behavior": null, "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 720125, "legacy": true}, {"created_at": "2025-09-27T00:00:25.178Z", "modified_at": "2024-09-03T16:16:06.332Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "tax_behavior": "exclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}], "benefits": [{"id": "", "created_at": "2025-07-05T15:21:14.498Z", "modified_at": "2023-11-21T02:59:50.838Z", "type": "downloadables", "description": "highlight sandy overspend scratchy yet by", "selectable": true, "deletable": false, "organization_id": ""}], "medias": []}, {"id": "", "created_at": "2024-02-06T13:10:07.718Z", "modified_at": "2025-05-28T09:18:17.409Z", "trial_interval": "week", "trial_interval_count": null, "name": "", "description": "gee unlike aboard entice which break", "visibility": "private", "recurring_interval": "month", "recurring_interval_count": 682397, "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2023-06-29T23:54:25.932Z", "modified_at": "2025-08-08T18:57:45.007Z", "id": "", "source": "ad_hoc", "amount_type": "metered_unit", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "unit_amount": "", "cap_amount": null, "meter_id": "", "meter": {"id": "", "name": ""}}, {"created_at": "2024-04-12T18:30:19.906Z", "modified_at": null, "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}], "benefits": [{"id": "", "created_at": "2025-07-05T15:21:14.498Z", "modified_at": "2023-11-21T02:59:50.838Z", "type": "downloadables", "description": "highlight sandy overspend scratchy yet by", "selectable": true, "deletable": false, "organization_id": ""}], "medias": []}, {"id": "", "created_at": "2024-02-06T13:10:07.718Z", "modified_at": "2025-05-28T09:18:17.409Z", "trial_interval": "year", "trial_interval_count": 754328, "name": "", "description": "gee unlike aboard entice which break", "visibility": "public", "recurring_interval": "month", "recurring_interval_count": 333080, "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2025-04-08T09:51:58.249Z", "modified_at": "2025-07-16T15:01:26.410Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "tax_behavior": "inclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2023-11-28T19:26:30.837Z", "modified_at": "2025-10-14T04:57:44.285Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "exclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 801449, "legacy": true}], "benefits": [{"id": "", "created_at": "2025-07-05T15:21:14.498Z", "modified_at": "2023-11-21T02:59:50.838Z", "type": "downloadables", "description": "highlight sandy overspend scratchy yet by", "selectable": true, "deletable": false, "organization_id": ""}], "medias": []}], "product": {"id": "", "created_at": "2024-04-04T09:43:29.328Z", "modified_at": "2024-01-03T07:24:30.583Z", "trial_interval": "week", "trial_interval_count": 140837, "name": "", "description": "patroller fax sadly sick bitterly indeed grandson bravely loyally wholly", "visibility": "private", "recurring_interval": "month", "recurring_interval_count": 496454, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2025-11-27T17:16:31.119Z", "modified_at": "2025-06-04T15:43:18.802Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 72487, "legacy": true}, {"created_at": "2024-06-14T15:19:42.985Z", "modified_at": "2025-08-21T13:42:50.786Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "tax_behavior": "location", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}, {"created_at": "2025-02-06T04:48:01.265Z", "modified_at": "2024-01-15T02:31:30.334Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": null, "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 849243, "maximum_amount": 295343, "preset_amount": 994380, "legacy": true}], "benefits": [{"id": "", "created_at": "2025-07-05T15:21:14.498Z", "modified_at": "2023-11-21T02:59:50.838Z", "type": "downloadables", "description": "highlight sandy overspend scratchy yet by", "selectable": true, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/opt", "mime_type": "", "size": 349206, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-11-20T22:00:21.061Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-10-01T19:20:04.513Z", "size_readable": "", "public_url": "https://noted-availability.info"}, {"id": "", "organization_id": "", "name": "", "path": "/opt", "mime_type": "", "size": 349206, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-11-20T22:00:21.061Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-10-01T19:20:04.513Z", "size_readable": "", "public_url": "https://noted-availability.info"}, {"id": "", "organization_id": "", "name": "", "path": "/opt", "mime_type": "", "size": 349206, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-11-20T22:00:21.061Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-10-01T19:20:04.513Z", "size_readable": "", "public_url": "https://noted-availability.info"}]}, "product_price": {"created_at": "2024-12-31T01:21:07.047Z", "modified_at": "2025-06-28T02:43:46.293Z", "id": "", "source": "ad_hoc", "amount_type": "metered_unit", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "unit_amount": "", "cap_amount": 912409, "meter_id": "", "meter": {"id": "", "name": ""}}, "prices": {"key": [], "key1": []}, "discount": {"duration": "once", "duration_in_months": 187379, "type": "fixed", "basis_points": 373595, "id": "", "name": "", "code": ""}, "subscription_id": "", "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-09-18T09:12:02.157Z", "modified_at": "2023-07-11T01:18:07.226Z", "id": "", "metadata": {"key": ""}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 704552, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2024-09-18T09:12:02.157Z", "modified_at": "2023-07-11T01:18:07.226Z", "id": "", "metadata": {"key": ""}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 704552, "required": true}], "customer_metadata": {"key": 384374, "key1": 126671, "key2": 568803}}} responses: "200": application/json: "" @@ -2100,7 +2116,7 @@ examples: _endpointsubscription_created_post: speakeasy-default-endpointsubscription-created-post: requestBody: - application/json: {"type": "subscription.created", "timestamp": "2024-05-03T11:46:21.459Z", "data": {"created_at": "2024-05-03T11:46:21.459Z", "modified_at": "2025-01-12T06:30:14.360Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "year", "recurring_interval_count": 445703, "status": "incomplete", "current_period_start": "2024-01-07T06:33:36.381Z", "current_period_end": "2024-07-30T16:54:44.427Z", "trial_start": "2023-12-03T10:52:23.880Z", "trial_end": "2024-05-29T05:21:44.072Z", "cancel_at_period_end": true, "canceled_at": "2023-09-10T18:39:16.136Z", "started_at": "2025-08-30T21:29:16.432Z", "ends_at": "2024-06-27T22:01:23.333Z", "ended_at": "2024-07-24T19:43:04.879Z", "customer_id": "", "product_id": "", "discount_id": null, "checkout_id": "", "customer_cancellation_reason": "missing_features", "customer_cancellation_comment": "", "metadata": {"key": false}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2023-05-18T22:55:50.482Z", "modified_at": "2024-08-04T23:52:10.438Z", "metadata": {"key": false, "key1": false}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2023-05-15T22:05:41.858Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2024-05-25T09:51:02.679Z", "modified_at": "2025-12-23T23:39:23.705Z", "trial_interval": "year", "trial_interval_count": 338753, "name": "", "description": "slink needily cemetery hydrocarbon a fledgling knit shirk appertain rural", "visibility": "private", "recurring_interval": "month", "recurring_interval_count": 677255, "is_recurring": true, "is_archived": false, "organization_id": "", "metadata": {}, "prices": [{"created_at": "2025-01-12T06:30:14.360Z", "modified_at": "2023-05-11T16:29:33.481Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 363951, "maximum_amount": 267138, "preset_amount": 230636, "legacy": true}, {"created_at": "2024-09-02T19:02:23.015Z", "modified_at": "2023-08-19T21:45:43.735Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}], "benefits": [{"id": "", "created_at": "2024-08-16T04:04:01.242Z", "modified_at": "2023-08-30T05:19:40.088Z", "type": "meter_credit", "description": "courageously quick-witted out equally toward though quietly", "selectable": true, "deletable": true, "organization_id": "", "metadata": {"key": 3195.27}, "properties": {"units": 371901, "rollover": false, "meter_id": ""}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/lost+found", "mime_type": "", "size": 719695, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-08-21T14:37:14.488Z", "version": null, "service": "product_media", "is_uploaded": false, "created_at": "2025-10-28T06:08:47.416Z", "size_readable": "", "public_url": "https://repentant-unit.org/"}, {"id": "", "organization_id": "", "name": "", "path": "/lost+found", "mime_type": "", "size": 719695, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-08-21T14:37:14.488Z", "version": null, "service": "product_media", "is_uploaded": false, "created_at": "2025-10-28T06:08:47.416Z", "size_readable": "", "public_url": "https://repentant-unit.org/"}, {"id": "", "organization_id": "", "name": "", "path": "/lost+found", "mime_type": "", "size": 719695, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-08-21T14:37:14.488Z", "version": null, "service": "product_media", "is_uploaded": false, "created_at": "2025-10-28T06:08:47.416Z", "size_readable": "", "public_url": "https://repentant-unit.org/"}], "attached_custom_fields": []}, "discount": {"duration": "once", "type": "fixed", "basis_points": 745503, "created_at": "2024-04-19T20:53:32.186Z", "modified_at": "2024-11-15T00:04:04.545Z", "id": "", "metadata": {"key": 3699.53}, "name": "", "code": "", "starts_at": "2024-10-15T21:24:43.202Z", "ends_at": "2025-09-26T06:55:01.272Z", "max_redemptions": 104800, "redemptions_count": 570322, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [{"created_at": "2023-11-26T09:15:00.973Z", "modified_at": "2024-01-19T16:01:53.249Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 125871, "legacy": true}], "meters": [{"created_at": "2025-05-17T01:58:02.155Z", "modified_at": "2024-09-29T09:35:40.427Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": 201601, "key1": true, "key2": 2057.75}, "created_at": "2025-03-06T04:32:46.256Z", "modified_at": "2024-01-13T00:47:03.334Z", "id": "", "name": "", "filter": {"conjunction": "or", "clauses": []}, "aggregation": {"func": "max", "property": ""}, "organization_id": ""}}, {"created_at": "2025-05-17T01:58:02.155Z", "modified_at": "2024-09-29T09:35:40.427Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": 201601, "key1": true, "key2": 2057.75}, "created_at": "2025-03-06T04:32:46.256Z", "modified_at": "2024-01-13T00:47:03.334Z", "id": "", "name": "", "filter": {"conjunction": "or", "clauses": []}, "aggregation": {"func": "max", "property": ""}, "organization_id": ""}}, {"created_at": "2025-05-17T01:58:02.155Z", "modified_at": "2024-09-29T09:35:40.427Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": 201601, "key1": true, "key2": 2057.75}, "created_at": "2025-03-06T04:32:46.256Z", "modified_at": "2024-01-13T00:47:03.334Z", "id": "", "name": "", "filter": {"conjunction": "or", "clauses": []}, "aggregation": {"func": "max", "property": ""}, "organization_id": ""}}]}} + application/json: {"type": "subscription.created", "timestamp": "2024-05-03T11:46:21.459Z", "data": {"created_at": "2024-05-03T11:46:21.459Z", "modified_at": "2025-01-12T06:30:14.360Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "year", "recurring_interval_count": 445703, "status": "incomplete", "current_period_start": "2024-01-07T06:33:36.381Z", "current_period_end": "2024-07-30T16:54:44.427Z", "trial_start": "2023-12-03T10:52:23.880Z", "trial_end": "2024-05-29T05:21:44.072Z", "cancel_at_period_end": true, "canceled_at": "2023-09-10T18:39:16.136Z", "started_at": "2025-08-30T21:29:16.432Z", "ends_at": "2024-06-27T22:01:23.333Z", "ended_at": "2024-07-24T19:43:04.879Z", "customer_id": "", "product_id": "", "discount_id": null, "checkout_id": "", "customer_cancellation_reason": "missing_features", "customer_cancellation_comment": "", "metadata": {"key": false}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2023-05-18T22:55:50.482Z", "modified_at": "2024-08-04T23:52:10.438Z", "metadata": {"key": false, "key1": false}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2023-05-15T22:05:41.858Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2024-05-25T09:51:02.679Z", "modified_at": "2025-12-23T23:39:23.705Z", "trial_interval": "year", "trial_interval_count": 338753, "name": "", "description": "slink needily cemetery hydrocarbon a fledgling knit shirk appertain rural", "visibility": "private", "recurring_interval": "month", "recurring_interval_count": 677255, "is_recurring": true, "is_archived": false, "organization_id": "", "metadata": {}, "prices": [{"created_at": "2025-01-12T06:30:14.360Z", "modified_at": "2023-05-11T16:29:33.481Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 363951, "maximum_amount": 267138, "preset_amount": 230636, "legacy": true}, {"created_at": "2024-09-02T19:02:23.015Z", "modified_at": "2023-08-19T21:45:43.735Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}], "benefits": [{"id": "", "created_at": "2024-08-16T04:04:01.242Z", "modified_at": "2023-08-30T05:19:40.088Z", "type": "meter_credit", "description": "courageously quick-witted out equally toward though quietly", "selectable": true, "deletable": true, "organization_id": "", "metadata": {"key": 3195.27}, "properties": {"units": 371901, "rollover": false, "meter_id": ""}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/lost+found", "mime_type": "", "size": 719695, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-08-21T14:37:14.488Z", "version": null, "service": "product_media", "is_uploaded": false, "created_at": "2025-10-28T06:08:47.416Z", "size_readable": "", "public_url": "https://repentant-unit.org/"}, {"id": "", "organization_id": "", "name": "", "path": "/lost+found", "mime_type": "", "size": 719695, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-08-21T14:37:14.488Z", "version": null, "service": "product_media", "is_uploaded": false, "created_at": "2025-10-28T06:08:47.416Z", "size_readable": "", "public_url": "https://repentant-unit.org/"}, {"id": "", "organization_id": "", "name": "", "path": "/lost+found", "mime_type": "", "size": 719695, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-08-21T14:37:14.488Z", "version": null, "service": "product_media", "is_uploaded": false, "created_at": "2025-10-28T06:08:47.416Z", "size_readable": "", "public_url": "https://repentant-unit.org/"}], "attached_custom_fields": []}, "discount": {"duration": "once", "type": "fixed", "basis_points": 745503, "created_at": "2024-04-19T20:53:32.186Z", "modified_at": "2024-11-15T00:04:04.545Z", "id": "", "metadata": {"key": 3699.53}, "name": "", "code": "", "starts_at": "2024-10-15T21:24:43.202Z", "ends_at": "2025-09-26T06:55:01.272Z", "max_redemptions": 104800, "redemptions_count": 570322, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [{"created_at": "2023-11-26T09:15:00.973Z", "modified_at": "2024-01-19T16:01:53.249Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 125871, "legacy": true}], "meters": [{"created_at": "2025-05-17T01:58:02.155Z", "modified_at": "2024-09-29T09:35:40.427Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": 201601, "key1": true, "key2": 2057.75}, "created_at": "2025-03-06T04:32:46.256Z", "modified_at": "2024-01-13T00:47:03.334Z", "id": "", "name": "", "filter": {"conjunction": "or", "clauses": []}, "aggregation": {"func": "max", "property": ""}, "organization_id": ""}}, {"created_at": "2025-05-17T01:58:02.155Z", "modified_at": "2024-09-29T09:35:40.427Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": 201601, "key1": true, "key2": 2057.75}, "created_at": "2025-03-06T04:32:46.256Z", "modified_at": "2024-01-13T00:47:03.334Z", "id": "", "name": "", "filter": {"conjunction": "or", "clauses": []}, "aggregation": {"func": "max", "property": ""}, "organization_id": ""}}, {"created_at": "2025-05-17T01:58:02.155Z", "modified_at": "2024-09-29T09:35:40.427Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": 201601, "key1": true, "key2": 2057.75}, "created_at": "2025-03-06T04:32:46.256Z", "modified_at": "2024-01-13T00:47:03.334Z", "id": "", "name": "", "filter": {"conjunction": "or", "clauses": []}, "aggregation": {"func": "max", "property": ""}, "organization_id": ""}}], "pending_update": {"created_at": "2025-01-06T06:33:36.381Z", "modified_at": "2025-07-30T16:54:44.427Z", "id": "", "applies_at": "2024-10-19T18:48:25.568Z", "product_id": "", "seats": 230391}}} responses: "200": application/json: "" @@ -2109,7 +2125,7 @@ examples: _endpointsubscription_updated_post: speakeasy-default-endpointsubscription-updated-post: requestBody: - application/json: {"type": "subscription.updated", "timestamp": "2023-06-24T13:26:25.969Z", "data": {"created_at": "2023-06-24T13:26:25.969Z", "modified_at": "2024-10-16T16:24:20.274Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 159270, "status": "canceled", "current_period_start": "2024-06-19T12:29:28.503Z", "current_period_end": "2023-08-24T22:14:10.131Z", "trial_start": "2024-05-25T12:11:24.717Z", "trial_end": "2024-07-08T02:17:23.799Z", "cancel_at_period_end": false, "canceled_at": "2025-08-31T06:08:08.476Z", "started_at": "2023-06-01T08:01:27.951Z", "ends_at": "2025-01-23T22:07:32.693Z", "ended_at": "2025-05-14T13:55:44.367Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "low_quality", "customer_cancellation_comment": "", "metadata": {"key": 477870, "key1": true, "key2": 485359}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2024-01-10T06:45:35.933Z", "modified_at": "2024-01-24T02:08:13.039Z", "metadata": {"key": 117983, "key1": 8500.16}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2025-08-09T14:29:57.545Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2024-12-02T17:09:45.787Z", "modified_at": "2025-03-11T00:51:56.943Z", "trial_interval": "week", "trial_interval_count": 488614, "name": "", "description": "obnoxiously save following clinch striking juicy", "visibility": "draft", "recurring_interval": "year", "recurring_interval_count": 597339, "is_recurring": true, "is_archived": false, "organization_id": "", "metadata": {"key": false, "key1": 884041, "key2": 4257.66}, "prices": [{"created_at": "2024-10-16T16:24:20.274Z", "modified_at": "2024-01-05T22:20:15.867Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 488614, "legacy": true}], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/srv", "mime_type": "", "size": 29348, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": null, "last_modified_at": "2023-10-03T10:28:13.472Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-10-07T09:47:56.854Z", "size_readable": "", "public_url": "https://flowery-promise.org/"}, {"id": "", "organization_id": "", "name": "", "path": "/srv", "mime_type": "", "size": 29348, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": null, "last_modified_at": "2023-10-03T10:28:13.472Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-10-07T09:47:56.854Z", "size_readable": "", "public_url": "https://flowery-promise.org/"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-01-10T20:33:55.554Z", "modified_at": "2023-03-14T14:16:19.041Z", "id": "", "metadata": {}, "type": "checkbox", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 766194, "required": false}]}, "discount": {"duration": "once", "type": "fixed", "amount": 1000, "currency": "usd", "amounts": {"eur": 900, "usd": 1000}, "created_at": "2023-06-09T06:11:59.062Z", "modified_at": "2024-09-28T05:16:48.757Z", "id": "", "metadata": {"key": 962223, "key1": 587522}, "name": "", "code": "", "starts_at": "2023-04-12T20:54:06.410Z", "ends_at": "2025-03-19T14:28:57.223Z", "max_redemptions": 852845, "redemptions_count": 658199, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [], "meters": [{"created_at": "2025-06-07T13:44:19.881Z", "modified_at": "2023-12-06T20:26:36.699Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": 6882, "key1": 556425, "key2": 117069}, "created_at": "2023-05-21T02:26:27.963Z", "modified_at": "2025-06-09T17:54:52.162Z", "id": "", "name": "", "filter": {"conjunction": "and", "clauses": [{"conjunction": "or", "clauses": []}, {"conjunction": "or", "clauses": []}]}, "aggregation": {"func": "avg", "property": ""}, "organization_id": ""}}, {"created_at": "2025-06-07T13:44:19.881Z", "modified_at": "2023-12-06T20:26:36.699Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": 6882, "key1": 556425, "key2": 117069}, "created_at": "2023-05-21T02:26:27.963Z", "modified_at": "2025-06-09T17:54:52.162Z", "id": "", "name": "", "filter": {"conjunction": "and", "clauses": [{"conjunction": "or", "clauses": []}, {"conjunction": "or", "clauses": []}]}, "aggregation": {"func": "avg", "property": ""}, "organization_id": ""}}]}} + application/json: {"type": "subscription.updated", "timestamp": "2023-06-24T13:26:25.969Z", "data": {"created_at": "2023-06-24T13:26:25.969Z", "modified_at": "2024-10-16T16:24:20.274Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 159270, "status": "canceled", "current_period_start": "2024-06-19T12:29:28.503Z", "current_period_end": "2023-08-24T22:14:10.131Z", "trial_start": "2024-05-25T12:11:24.717Z", "trial_end": "2024-07-08T02:17:23.799Z", "cancel_at_period_end": false, "canceled_at": "2025-08-31T06:08:08.476Z", "started_at": "2023-06-01T08:01:27.951Z", "ends_at": "2025-01-23T22:07:32.693Z", "ended_at": "2025-05-14T13:55:44.367Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "low_quality", "customer_cancellation_comment": "", "metadata": {"key": 477870, "key1": true, "key2": 485359}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2024-01-10T06:45:35.933Z", "modified_at": "2024-01-24T02:08:13.039Z", "metadata": {"key": 117983, "key1": 8500.16}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2025-08-09T14:29:57.545Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2024-12-02T17:09:45.787Z", "modified_at": "2025-03-11T00:51:56.943Z", "trial_interval": "week", "trial_interval_count": 488614, "name": "", "description": "obnoxiously save following clinch striking juicy", "visibility": "draft", "recurring_interval": "year", "recurring_interval_count": 597339, "is_recurring": true, "is_archived": false, "organization_id": "", "metadata": {"key": false, "key1": 884041, "key2": 4257.66}, "prices": [{"created_at": "2024-10-16T16:24:20.274Z", "modified_at": "2024-01-05T22:20:15.867Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "inclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 488614, "legacy": true}], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/srv", "mime_type": "", "size": 29348, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": null, "last_modified_at": "2023-10-03T10:28:13.472Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-10-07T09:47:56.854Z", "size_readable": "", "public_url": "https://flowery-promise.org/"}, {"id": "", "organization_id": "", "name": "", "path": "/srv", "mime_type": "", "size": 29348, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": null, "last_modified_at": "2023-10-03T10:28:13.472Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-10-07T09:47:56.854Z", "size_readable": "", "public_url": "https://flowery-promise.org/"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-01-10T20:33:55.554Z", "modified_at": "2023-03-14T14:16:19.041Z", "id": "", "metadata": {}, "type": "checkbox", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 766194, "required": false}]}, "discount": {"duration": "once", "type": "fixed", "amount": 1000, "currency": "usd", "amounts": {"eur": 900, "usd": 1000}, "created_at": "2023-06-09T06:11:59.062Z", "modified_at": "2024-09-28T05:16:48.757Z", "id": "", "metadata": {"key": 962223, "key1": 587522}, "name": "", "code": "", "starts_at": "2023-04-12T20:54:06.410Z", "ends_at": "2025-03-19T14:28:57.223Z", "max_redemptions": 852845, "redemptions_count": 658199, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [], "meters": [{"created_at": "2025-06-07T13:44:19.881Z", "modified_at": "2023-12-06T20:26:36.699Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": 6882, "key1": 556425, "key2": 117069}, "created_at": "2023-05-21T02:26:27.963Z", "modified_at": "2025-06-09T17:54:52.162Z", "id": "", "name": "", "filter": {"conjunction": "and", "clauses": [{"conjunction": "or", "clauses": []}, {"conjunction": "or", "clauses": []}]}, "aggregation": {"func": "avg", "property": ""}, "organization_id": ""}}, {"created_at": "2025-06-07T13:44:19.881Z", "modified_at": "2023-12-06T20:26:36.699Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": 6882, "key1": 556425, "key2": 117069}, "created_at": "2023-05-21T02:26:27.963Z", "modified_at": "2025-06-09T17:54:52.162Z", "id": "", "name": "", "filter": {"conjunction": "and", "clauses": [{"conjunction": "or", "clauses": []}, {"conjunction": "or", "clauses": []}]}, "aggregation": {"func": "avg", "property": ""}, "organization_id": ""}}], "pending_update": {"created_at": "2025-07-08T02:17:23.799Z", "modified_at": "2025-06-20T20:38:29.855Z", "id": "", "applies_at": "2026-03-19T13:26:31.175Z", "product_id": "", "seats": 215261}}} responses: "200": application/json: "" @@ -2118,7 +2134,7 @@ examples: _endpointsubscription_active_post: speakeasy-default-endpointsubscription-active-post: requestBody: - application/json: {"type": "subscription.active", "timestamp": "2023-08-13T01:28:21.362Z", "data": {"created_at": "2023-08-13T01:28:21.362Z", "modified_at": "2024-06-25T00:41:05.678Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 204435, "status": "past_due", "current_period_start": "2023-06-09T14:14:48.363Z", "current_period_end": "2024-08-12T01:28:21.362Z", "trial_start": "2023-10-12T10:17:29.274Z", "trial_end": "2023-12-18T04:45:55.702Z", "cancel_at_period_end": true, "canceled_at": null, "started_at": "2023-07-21T07:29:31.409Z", "ends_at": "2025-08-05T11:38:46.213Z", "ended_at": "2024-09-05T04:27:23.768Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "too_complex", "customer_cancellation_comment": "", "metadata": {"key": false}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2024-08-17T18:35:42.212Z", "modified_at": "2025-01-01T23:32:39.659Z", "metadata": {"key": 7303.56, "key1": 796236}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": null, "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2025-11-05T10:18:40.300Z", "modified_at": "2024-04-23T18:24:43.408Z", "trial_interval": "week", "trial_interval_count": 145614, "name": "", "description": "athwart fail wound oh nor boohoo reasoning against since", "visibility": "draft", "recurring_interval": "month", "recurring_interval_count": 493639, "is_recurring": false, "is_archived": true, "organization_id": "", "metadata": {"key": 722592}, "prices": [], "benefits": [{"id": "", "created_at": "2025-05-21T10:49:13.924Z", "modified_at": null, "type": "license_keys", "description": "chime softly outgoing gray", "selectable": false, "deletable": false, "organization_id": "", "metadata": {}, "properties": {"prefix": "", "expires": {"ttl": 18256, "timeframe": "day"}, "activations": {"limit": 776442, "enable_customer_admin": false}, "limit_usage": 89994}}, {"id": "", "created_at": "2023-02-11T00:08:34.711Z", "modified_at": "2024-10-21T08:00:16.195Z", "type": "github_repository", "description": "as draft noon kettledrum alligator", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 331688, "key1": 10869, "key2": true}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "maintain"}}, {"id": "", "created_at": "2023-02-11T00:08:34.711Z", "modified_at": "2024-10-21T08:00:16.195Z", "type": "github_repository", "description": "as draft noon kettledrum alligator", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 331688, "key1": 10869, "key2": true}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "maintain"}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/usr/libexec", "mime_type": "", "size": 980211, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-09-01T03:11:19.881Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-05-05T22:00:20.852Z", "size_readable": "", "public_url": "https://shabby-integer.org"}, {"id": "", "organization_id": "", "name": "", "path": "/usr/libexec", "mime_type": "", "size": 980211, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-09-01T03:11:19.881Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-05-05T22:00:20.852Z", "size_readable": "", "public_url": "https://shabby-integer.org"}, {"id": "", "organization_id": "", "name": "", "path": "/usr/libexec", "mime_type": "", "size": 980211, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-09-01T03:11:19.881Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-05-05T22:00:20.852Z", "size_readable": "", "public_url": "https://shabby-integer.org"}], "attached_custom_fields": []}, "discount": {"duration": "repeating", "type": "percentage", "amount": 1000, "currency": "usd", "amounts": {"eur": 900, "usd": 1000}, "created_at": "2023-10-09T08:41:16.911Z", "modified_at": "2025-08-16T07:28:28.929Z", "id": "", "metadata": {}, "name": "", "code": "", "starts_at": "2024-04-06T16:40:05.860Z", "ends_at": "2023-01-06T22:21:47.288Z", "max_redemptions": null, "redemptions_count": 313365, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [{"created_at": "2024-06-25T00:41:05.678Z", "modified_at": "2025-09-12T00:30:21.037Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 89762, "maximum_amount": null, "preset_amount": null, "legacy": true}, {"created_at": "2024-09-14T15:19:58.463Z", "modified_at": "2024-07-30T05:01:30.550Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 720352, "maximum_amount": 761885, "preset_amount": 542678, "legacy": true}, {"created_at": "2025-02-14T12:59:50.680Z", "modified_at": "2025-03-11T11:17:02.540Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}], "meters": []}} + application/json: {"type": "subscription.active", "timestamp": "2023-08-13T01:28:21.362Z", "data": {"created_at": "2023-08-13T01:28:21.362Z", "modified_at": "2024-06-25T00:41:05.678Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 204435, "status": "past_due", "current_period_start": "2023-06-09T14:14:48.363Z", "current_period_end": "2024-08-12T01:28:21.362Z", "trial_start": "2023-10-12T10:17:29.274Z", "trial_end": "2023-12-18T04:45:55.702Z", "cancel_at_period_end": true, "canceled_at": null, "started_at": "2023-07-21T07:29:31.409Z", "ends_at": "2025-08-05T11:38:46.213Z", "ended_at": "2024-09-05T04:27:23.768Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "too_complex", "customer_cancellation_comment": "", "metadata": {"key": false}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2024-08-17T18:35:42.212Z", "modified_at": "2025-01-01T23:32:39.659Z", "metadata": {"key": 7303.56, "key1": 796236}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": null, "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2025-11-05T10:18:40.300Z", "modified_at": "2024-04-23T18:24:43.408Z", "trial_interval": "week", "trial_interval_count": 145614, "name": "", "description": "athwart fail wound oh nor boohoo reasoning against since", "visibility": "draft", "recurring_interval": "month", "recurring_interval_count": 493639, "is_recurring": false, "is_archived": true, "organization_id": "", "metadata": {"key": 722592}, "prices": [], "benefits": [{"id": "", "created_at": "2025-05-21T10:49:13.924Z", "modified_at": null, "type": "license_keys", "description": "chime softly outgoing gray", "selectable": false, "deletable": false, "organization_id": "", "metadata": {}, "properties": {"prefix": "", "expires": {"ttl": 18256, "timeframe": "day"}, "activations": {"limit": 776442, "enable_customer_admin": false}, "limit_usage": 89994}}, {"id": "", "created_at": "2023-02-11T00:08:34.711Z", "modified_at": "2024-10-21T08:00:16.195Z", "type": "github_repository", "description": "as draft noon kettledrum alligator", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 331688, "key1": 10869, "key2": true}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "maintain"}}, {"id": "", "created_at": "2023-02-11T00:08:34.711Z", "modified_at": "2024-10-21T08:00:16.195Z", "type": "github_repository", "description": "as draft noon kettledrum alligator", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 331688, "key1": 10869, "key2": true}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "maintain"}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/usr/libexec", "mime_type": "", "size": 980211, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-09-01T03:11:19.881Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-05-05T22:00:20.852Z", "size_readable": "", "public_url": "https://shabby-integer.org"}, {"id": "", "organization_id": "", "name": "", "path": "/usr/libexec", "mime_type": "", "size": 980211, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-09-01T03:11:19.881Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-05-05T22:00:20.852Z", "size_readable": "", "public_url": "https://shabby-integer.org"}, {"id": "", "organization_id": "", "name": "", "path": "/usr/libexec", "mime_type": "", "size": 980211, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-09-01T03:11:19.881Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-05-05T22:00:20.852Z", "size_readable": "", "public_url": "https://shabby-integer.org"}], "attached_custom_fields": []}, "discount": {"duration": "repeating", "type": "percentage", "amount": 1000, "currency": "usd", "amounts": {"eur": 900, "usd": 1000}, "created_at": "2023-10-09T08:41:16.911Z", "modified_at": "2025-08-16T07:28:28.929Z", "id": "", "metadata": {}, "name": "", "code": "", "starts_at": "2024-04-06T16:40:05.860Z", "ends_at": "2023-01-06T22:21:47.288Z", "max_redemptions": null, "redemptions_count": 313365, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [{"created_at": "2024-06-25T00:41:05.678Z", "modified_at": "2025-09-12T00:30:21.037Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 89762, "maximum_amount": null, "preset_amount": null, "legacy": true}, {"created_at": "2024-09-14T15:19:58.463Z", "modified_at": "2024-07-30T05:01:30.550Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 720352, "maximum_amount": 761885, "preset_amount": 542678, "legacy": true}, {"created_at": "2025-02-14T12:59:50.680Z", "modified_at": "2025-03-11T11:17:02.540Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}], "meters": [], "pending_update": {"created_at": "2024-06-08T14:14:48.363Z", "modified_at": null, "id": "", "applies_at": "2024-02-09T14:19:47.352Z", "product_id": null, "seats": 183679}}} responses: "200": application/json: "" @@ -2127,7 +2143,7 @@ examples: _endpointsubscription_canceled_post: speakeasy-default-endpointsubscription-canceled-post: requestBody: - application/json: {"type": "subscription.canceled", "timestamp": "2025-02-09T04:39:02.332Z", "data": {"created_at": "2025-02-09T04:39:02.332Z", "modified_at": "2023-04-18T10:38:03.481Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 702732, "status": "active", "current_period_start": "2023-06-17T04:15:56.819Z", "current_period_end": "2023-06-02T15:48:16.857Z", "trial_start": "2025-04-09T17:46:08.645Z", "trial_end": null, "cancel_at_period_end": false, "canceled_at": "2024-01-07T18:54:45.602Z", "started_at": "2025-02-23T12:23:49.579Z", "ends_at": "2023-11-16T08:24:59.166Z", "ended_at": "2023-07-21T16:25:14.433Z", "customer_id": "", "product_id": "", "discount_id": null, "checkout_id": null, "customer_cancellation_reason": null, "customer_cancellation_comment": "", "metadata": {}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2023-10-25T05:52:42.846Z", "modified_at": "2023-09-20T10:20:50.540Z", "metadata": {"key": true}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2023-07-13T08:26:56.650Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2025-06-11T17:21:10.206Z", "modified_at": "2025-03-18T13:26:34.470Z", "trial_interval": "year", "trial_interval_count": 538272, "name": "", "description": "unimpressively stiffen promptly", "visibility": "public", "recurring_interval": "year", "recurring_interval_count": 98032, "is_recurring": false, "is_archived": true, "organization_id": "", "metadata": {"key": true}, "prices": [{"created_at": "2023-04-18T10:38:03.481Z", "modified_at": "2025-08-08T10:15:56.533Z", "id": "", "source": "ad_hoc", "amount_type": "metered_unit", "price_currency": "", "is_archived": true, "product_id": "", "unit_amount": "", "cap_amount": 739654, "meter_id": "", "meter": {"id": "", "name": ""}}, {"created_at": "2025-04-18T11:08:34.147Z", "modified_at": "2023-05-05T03:28:24.281Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 25751, "legacy": true}], "benefits": [{"id": "", "created_at": "2024-09-21T18:00:22.332Z", "modified_at": "2023-05-12T19:14:12.206Z", "type": "downloadables", "description": "ostrich smog zowie loyally naturally noisily castanet pace deliberately", "selectable": false, "deletable": true, "organization_id": "", "metadata": {}, "properties": {"archived": {"key": true, "key1": true}, "files": []}}, {"id": "", "created_at": "2025-12-18T22:12:17.302Z", "modified_at": "2024-10-10T09:48:09.804Z", "type": "custom", "description": "knavishly goat programme intrigue elegantly fooey decisive", "selectable": false, "deletable": false, "organization_id": "", "metadata": {"key": false, "key1": 922.01, "key2": 5307.16}, "properties": {"note": ""}}, {"id": "", "created_at": "2024-06-11T13:23:03.299Z", "modified_at": "2024-10-18T20:00:03.185Z", "type": "meter_credit", "description": "at like through stale yum corny", "selectable": true, "deletable": true, "organization_id": "", "metadata": {"key": false}, "properties": {"units": 743161, "rollover": false, "meter_id": ""}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/var/yp", "mime_type": "", "size": 91402, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": null, "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-02-20T02:39:11.781Z", "size_readable": "", "public_url": "https://young-obesity.org"}, {"id": "", "organization_id": "", "name": "", "path": "/var/yp", "mime_type": "", "size": 91402, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": null, "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-02-20T02:39:11.781Z", "size_readable": "", "public_url": "https://young-obesity.org"}], "attached_custom_fields": []}, "discount": {"duration": "once", "type": "fixed", "basis_points": 942713, "created_at": "2025-05-02T10:03:23.149Z", "modified_at": "2024-03-07T17:30:21.663Z", "id": "", "metadata": {"key": "", "key1": false, "key2": ""}, "name": "", "code": "", "starts_at": "2025-11-05T08:42:03.906Z", "ends_at": null, "max_redemptions": 510938, "redemptions_count": 760335, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [{"created_at": "2023-08-10T09:00:25.178Z", "modified_at": "2023-05-20T04:28:47.140Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}], "meters": []}} + application/json: {"type": "subscription.canceled", "timestamp": "2025-02-09T04:39:02.332Z", "data": {"created_at": "2025-02-09T04:39:02.332Z", "modified_at": "2023-04-18T10:38:03.481Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 702732, "status": "active", "current_period_start": "2023-06-17T04:15:56.819Z", "current_period_end": "2023-06-02T15:48:16.857Z", "trial_start": "2025-04-09T17:46:08.645Z", "trial_end": null, "cancel_at_period_end": false, "canceled_at": "2024-01-07T18:54:45.602Z", "started_at": "2025-02-23T12:23:49.579Z", "ends_at": "2023-11-16T08:24:59.166Z", "ended_at": "2023-07-21T16:25:14.433Z", "customer_id": "", "product_id": "", "discount_id": null, "checkout_id": null, "customer_cancellation_reason": null, "customer_cancellation_comment": "", "metadata": {}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2023-10-25T05:52:42.846Z", "modified_at": "2023-09-20T10:20:50.540Z", "metadata": {"key": true}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2023-07-13T08:26:56.650Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2025-06-11T17:21:10.206Z", "modified_at": "2025-03-18T13:26:34.470Z", "trial_interval": "year", "trial_interval_count": 538272, "name": "", "description": "unimpressively stiffen promptly", "visibility": "public", "recurring_interval": "year", "recurring_interval_count": 98032, "is_recurring": false, "is_archived": true, "organization_id": "", "metadata": {"key": true}, "prices": [{"created_at": "2023-04-18T10:38:03.481Z", "modified_at": "2025-08-08T10:15:56.533Z", "id": "", "source": "ad_hoc", "amount_type": "metered_unit", "price_currency": "", "tax_behavior": "exclusive", "is_archived": true, "product_id": "", "unit_amount": "", "cap_amount": 739654, "meter_id": "", "meter": {"id": "", "name": ""}}, {"created_at": "2025-04-18T11:08:34.147Z", "modified_at": "2023-05-05T03:28:24.281Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "tax_behavior": null, "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 25751, "legacy": true}], "benefits": [{"id": "", "created_at": "2024-09-21T18:00:22.332Z", "modified_at": "2023-05-12T19:14:12.206Z", "type": "downloadables", "description": "ostrich smog zowie loyally naturally noisily castanet pace deliberately", "selectable": false, "deletable": true, "organization_id": "", "metadata": {}, "properties": {"archived": {"key": true, "key1": true}, "files": []}}, {"id": "", "created_at": "2025-12-18T22:12:17.302Z", "modified_at": "2024-10-10T09:48:09.804Z", "type": "custom", "description": "knavishly goat programme intrigue elegantly fooey decisive", "selectable": false, "deletable": false, "organization_id": "", "metadata": {"key": false, "key1": 922.01, "key2": 5307.16}, "properties": {"note": ""}}, {"id": "", "created_at": "2024-06-11T13:23:03.299Z", "modified_at": "2024-10-18T20:00:03.185Z", "type": "meter_credit", "description": "at like through stale yum corny", "selectable": true, "deletable": true, "organization_id": "", "metadata": {"key": false}, "properties": {"units": 743161, "rollover": false, "meter_id": ""}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/var/yp", "mime_type": "", "size": 91402, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": null, "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-02-20T02:39:11.781Z", "size_readable": "", "public_url": "https://young-obesity.org"}, {"id": "", "organization_id": "", "name": "", "path": "/var/yp", "mime_type": "", "size": 91402, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": null, "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-02-20T02:39:11.781Z", "size_readable": "", "public_url": "https://young-obesity.org"}], "attached_custom_fields": []}, "discount": {"duration": "once", "type": "fixed", "basis_points": 942713, "created_at": "2025-05-02T10:03:23.149Z", "modified_at": "2024-03-07T17:30:21.663Z", "id": "", "metadata": {"key": "", "key1": false, "key2": ""}, "name": "", "code": "", "starts_at": "2025-11-05T08:42:03.906Z", "ends_at": null, "max_redemptions": 510938, "redemptions_count": 760335, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [{"created_at": "2023-08-10T09:00:25.178Z", "modified_at": "2023-05-20T04:28:47.140Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "tax_behavior": "exclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}], "meters": [], "pending_update": {"created_at": "2025-08-12T22:41:41.907Z", "modified_at": "2024-08-03T03:14:29.655Z", "id": "", "applies_at": "2024-06-01T15:48:16.857Z", "product_id": "", "seats": 339222}}} responses: "200": application/json: "" @@ -2136,7 +2152,7 @@ examples: _endpointsubscription_uncanceled_post: speakeasy-default-endpointsubscription-uncanceled-post: requestBody: - application/json: {"type": "subscription.uncanceled", "timestamp": "2023-02-06T17:25:10.106Z", "data": {"created_at": "2023-02-06T17:25:10.106Z", "modified_at": "2023-01-25T07:20:02.381Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 33508, "status": "canceled", "current_period_start": "2024-04-11T19:08:16.655Z", "current_period_end": "2023-08-23T01:03:59.107Z", "trial_start": null, "trial_end": "2023-01-25T07:20:02.381Z", "cancel_at_period_end": true, "canceled_at": "2024-11-16T02:01:16.824Z", "started_at": null, "ends_at": "2023-12-23T04:50:00.016Z", "ended_at": "2024-10-18T16:25:47.209Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": null, "customer_cancellation_reason": "low_quality", "customer_cancellation_comment": "", "metadata": {}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2025-10-01T20:42:25.530Z", "modified_at": "2024-07-04T17:30:56.477Z", "metadata": {}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2024-12-20T09:31:52.259Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2024-03-26T06:19:23.237Z", "modified_at": "2024-05-11T18:08:21.251Z", "trial_interval": "week", "trial_interval_count": 809387, "name": "", "description": "questioningly proliferate yet vanish mooch yowza hopeful", "visibility": "draft", "recurring_interval": "month", "recurring_interval_count": 22176, "is_recurring": true, "is_archived": true, "organization_id": "", "metadata": {}, "prices": [{"created_at": "2023-01-25T07:20:02.381Z", "modified_at": "2024-03-21T16:37:42.322Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 107066, "maximum_amount": 251812, "preset_amount": 625077, "legacy": true}], "benefits": [{"id": "", "created_at": "2024-07-09T11:35:46.121Z", "modified_at": "2024-07-14T11:45:04.348Z", "type": "downloadables", "description": "esteemed aha arcade", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 549444}, "properties": {"archived": {"key": false, "key1": false, "key2": true}, "files": [""]}}, {"id": "", "created_at": "2023-07-17T10:10:30.145Z", "modified_at": "2024-02-22T01:39:19.437Z", "type": "github_repository", "description": "hmph frantically for into unfurl rapidly when", "selectable": false, "deletable": true, "organization_id": "", "metadata": {"key": ""}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "admin"}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/etc/namedb", "mime_type": "", "size": 865781, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": "2024-09-05T02:35:48.322Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-12-06T10:04:39.843Z", "size_readable": "", "public_url": "https://normal-giant.org/"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2025-05-08T20:53:14.936Z", "modified_at": "2025-08-01T19:32:49.347Z", "id": "", "metadata": {"key": 791230}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 887720, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2025-05-08T20:53:14.936Z", "modified_at": "2025-08-01T19:32:49.347Z", "id": "", "metadata": {"key": 791230}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 887720, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2025-05-08T20:53:14.936Z", "modified_at": "2025-08-01T19:32:49.347Z", "id": "", "metadata": {"key": 791230}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 887720, "required": false}]}, "discount": {"duration": "once", "type": "fixed", "basis_points": 408479, "created_at": "2023-03-14T02:37:49.424Z", "modified_at": "2025-12-23T02:41:08.695Z", "id": "", "metadata": {}, "name": "", "code": "", "starts_at": "2024-07-07T16:21:42.534Z", "ends_at": "2023-05-08T21:16:10.476Z", "max_redemptions": 431440, "redemptions_count": 127195, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [{"created_at": "2023-12-23T04:50:00.016Z", "modified_at": "2024-10-18T16:25:47.209Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 138645, "maximum_amount": 95755, "preset_amount": 417130, "legacy": true}], "meters": [{"created_at": "2025-11-08T06:13:24.540Z", "modified_at": "2023-05-26T16:36:35.734Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": 479423, "key1": 327992}, "created_at": "2025-01-03T20:59:19.837Z", "modified_at": "2024-09-23T23:32:35.223Z", "id": "", "name": "", "filter": {"conjunction": "and", "clauses": []}, "aggregation": {"func": "avg", "property": ""}, "organization_id": ""}}, {"created_at": "2025-11-08T06:13:24.540Z", "modified_at": "2023-05-26T16:36:35.734Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": 479423, "key1": 327992}, "created_at": "2025-01-03T20:59:19.837Z", "modified_at": "2024-09-23T23:32:35.223Z", "id": "", "name": "", "filter": {"conjunction": "and", "clauses": []}, "aggregation": {"func": "avg", "property": ""}, "organization_id": ""}}, {"created_at": "2025-11-08T06:13:24.540Z", "modified_at": "2023-05-26T16:36:35.734Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": 479423, "key1": 327992}, "created_at": "2025-01-03T20:59:19.837Z", "modified_at": "2024-09-23T23:32:35.223Z", "id": "", "name": "", "filter": {"conjunction": "and", "clauses": []}, "aggregation": {"func": "avg", "property": ""}, "organization_id": ""}}]}} + application/json: {"type": "subscription.uncanceled", "timestamp": "2023-02-06T17:25:10.106Z", "data": {"created_at": "2023-02-06T17:25:10.106Z", "modified_at": "2023-01-25T07:20:02.381Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 33508, "status": "canceled", "current_period_start": "2024-04-11T19:08:16.655Z", "current_period_end": "2023-08-23T01:03:59.107Z", "trial_start": null, "trial_end": "2023-01-25T07:20:02.381Z", "cancel_at_period_end": true, "canceled_at": "2024-11-16T02:01:16.824Z", "started_at": null, "ends_at": "2023-12-23T04:50:00.016Z", "ended_at": "2024-10-18T16:25:47.209Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": null, "customer_cancellation_reason": "low_quality", "customer_cancellation_comment": "", "metadata": {}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2025-10-01T20:42:25.530Z", "modified_at": "2024-07-04T17:30:56.477Z", "metadata": {}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2024-12-20T09:31:52.259Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2024-03-26T06:19:23.237Z", "modified_at": "2024-05-11T18:08:21.251Z", "trial_interval": "week", "trial_interval_count": 809387, "name": "", "description": "questioningly proliferate yet vanish mooch yowza hopeful", "visibility": "draft", "recurring_interval": "month", "recurring_interval_count": 22176, "is_recurring": true, "is_archived": true, "organization_id": "", "metadata": {}, "prices": [{"created_at": "2023-01-25T07:20:02.381Z", "modified_at": "2024-03-21T16:37:42.322Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": null, "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 107066, "maximum_amount": 251812, "preset_amount": 625077, "legacy": true}], "benefits": [{"id": "", "created_at": "2024-07-09T11:35:46.121Z", "modified_at": "2024-07-14T11:45:04.348Z", "type": "downloadables", "description": "esteemed aha arcade", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 549444}, "properties": {"archived": {"key": false, "key1": false, "key2": true}, "files": [""]}}, {"id": "", "created_at": "2023-07-17T10:10:30.145Z", "modified_at": "2024-02-22T01:39:19.437Z", "type": "github_repository", "description": "hmph frantically for into unfurl rapidly when", "selectable": false, "deletable": true, "organization_id": "", "metadata": {"key": ""}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "admin"}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/etc/namedb", "mime_type": "", "size": 865781, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": "2024-09-05T02:35:48.322Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-12-06T10:04:39.843Z", "size_readable": "", "public_url": "https://normal-giant.org/"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2025-05-08T20:53:14.936Z", "modified_at": "2025-08-01T19:32:49.347Z", "id": "", "metadata": {"key": 791230}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 887720, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2025-05-08T20:53:14.936Z", "modified_at": "2025-08-01T19:32:49.347Z", "id": "", "metadata": {"key": 791230}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 887720, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2025-05-08T20:53:14.936Z", "modified_at": "2025-08-01T19:32:49.347Z", "id": "", "metadata": {"key": 791230}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 887720, "required": false}]}, "discount": {"duration": "once", "type": "fixed", "basis_points": 408479, "created_at": "2023-03-14T02:37:49.424Z", "modified_at": "2025-12-23T02:41:08.695Z", "id": "", "metadata": {}, "name": "", "code": "", "starts_at": "2024-07-07T16:21:42.534Z", "ends_at": "2023-05-08T21:16:10.476Z", "max_redemptions": 431440, "redemptions_count": 127195, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [{"created_at": "2023-12-23T04:50:00.016Z", "modified_at": "2024-10-18T16:25:47.209Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 138645, "maximum_amount": 95755, "preset_amount": 417130, "legacy": true}], "meters": [{"created_at": "2025-11-08T06:13:24.540Z", "modified_at": "2023-05-26T16:36:35.734Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": 479423, "key1": 327992}, "created_at": "2025-01-03T20:59:19.837Z", "modified_at": "2024-09-23T23:32:35.223Z", "id": "", "name": "", "filter": {"conjunction": "and", "clauses": []}, "aggregation": {"func": "avg", "property": ""}, "organization_id": ""}}, {"created_at": "2025-11-08T06:13:24.540Z", "modified_at": "2023-05-26T16:36:35.734Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": 479423, "key1": 327992}, "created_at": "2025-01-03T20:59:19.837Z", "modified_at": "2024-09-23T23:32:35.223Z", "id": "", "name": "", "filter": {"conjunction": "and", "clauses": []}, "aggregation": {"func": "avg", "property": ""}, "organization_id": ""}}, {"created_at": "2025-11-08T06:13:24.540Z", "modified_at": "2023-05-26T16:36:35.734Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": 479423, "key1": 327992}, "created_at": "2025-01-03T20:59:19.837Z", "modified_at": "2024-09-23T23:32:35.223Z", "id": "", "name": "", "filter": {"conjunction": "and", "clauses": []}, "aggregation": {"func": "avg", "property": ""}, "organization_id": ""}}], "pending_update": {"created_at": "2025-03-21T16:37:42.322Z", "modified_at": "2026-06-06T02:06:49.326Z", "id": "", "applies_at": "2025-04-11T19:08:16.655Z", "product_id": "", "seats": 251812}}} responses: "200": application/json: "" @@ -2145,7 +2161,7 @@ examples: _endpointsubscription_revoked_post: speakeasy-default-endpointsubscription-revoked-post: requestBody: - application/json: {"type": "subscription.revoked", "timestamp": "2024-01-02T06:40:50.860Z", "data": {"created_at": "2024-01-02T06:40:50.860Z", "modified_at": null, "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 334195, "status": "canceled", "current_period_start": "2024-04-30T10:39:59.432Z", "current_period_end": "2025-03-19T11:29:47.842Z", "trial_start": "2023-03-16T08:42:29.566Z", "trial_end": "2023-10-28T01:20:21.930Z", "cancel_at_period_end": true, "canceled_at": "2023-02-17T04:59:11.584Z", "started_at": "2024-02-14T23:20:57.498Z", "ends_at": "2025-04-28T23:19:31.379Z", "ended_at": "2023-04-29T06:37:50.213Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "customer_service", "customer_cancellation_comment": "", "metadata": {"key": 764246}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2025-03-17T11:47:03.932Z", "modified_at": "2025-12-12T02:48:12.123Z", "metadata": {"key": true, "key1": 683572}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2025-12-09T13:41:39.970Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2025-05-31T05:10:14.997Z", "modified_at": "2024-05-08T09:12:04.956Z", "trial_interval": null, "trial_interval_count": 442924, "name": "", "description": "pace aside typewriter if oh almost supposing twine", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": null, "is_recurring": true, "is_archived": false, "organization_id": "", "metadata": {"key": 956675}, "prices": [], "benefits": [{"id": "", "created_at": "2024-06-28T04:33:55.419Z", "modified_at": "2023-04-08T23:58:31.520Z", "type": "github_repository", "description": "eventually holster drab finished than sanity wiggly surprisingly judicious", "selectable": true, "deletable": true, "organization_id": "", "metadata": {"key": false, "key1": 683668, "key2": 4880.9}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "admin"}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Users", "mime_type": "", "size": 789606, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-10-08T06:21:41.000Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2024-12-10T00:21:44.017Z", "size_readable": "", "public_url": "https://poor-duster.name/"}, {"id": "", "organization_id": "", "name": "", "path": "/Users", "mime_type": "", "size": 789606, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-10-08T06:21:41.000Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2024-12-10T00:21:44.017Z", "size_readable": "", "public_url": "https://poor-duster.name/"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-02-06T03:19:32.386Z", "modified_at": "2023-10-17T04:09:43.608Z", "id": "", "metadata": {}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 575720, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2024-02-06T03:19:32.386Z", "modified_at": "2023-10-17T04:09:43.608Z", "id": "", "metadata": {}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 575720, "required": false}]}, "discount": null, "prices": [], "meters": []}} + application/json: {"type": "subscription.revoked", "timestamp": "2024-01-02T06:40:50.860Z", "data": {"created_at": "2024-01-02T06:40:50.860Z", "modified_at": null, "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 334195, "status": "canceled", "current_period_start": "2024-04-30T10:39:59.432Z", "current_period_end": "2025-03-19T11:29:47.842Z", "trial_start": "2023-03-16T08:42:29.566Z", "trial_end": "2023-10-28T01:20:21.930Z", "cancel_at_period_end": true, "canceled_at": "2023-02-17T04:59:11.584Z", "started_at": "2024-02-14T23:20:57.498Z", "ends_at": "2025-04-28T23:19:31.379Z", "ended_at": "2023-04-29T06:37:50.213Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "customer_service", "customer_cancellation_comment": "", "metadata": {"key": 764246}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2025-03-17T11:47:03.932Z", "modified_at": "2025-12-12T02:48:12.123Z", "metadata": {"key": true, "key1": 683572}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2025-12-09T13:41:39.970Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2025-05-31T05:10:14.997Z", "modified_at": "2024-05-08T09:12:04.956Z", "trial_interval": null, "trial_interval_count": 442924, "name": "", "description": "pace aside typewriter if oh almost supposing twine", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": null, "is_recurring": true, "is_archived": false, "organization_id": "", "metadata": {"key": 956675}, "prices": [], "benefits": [{"id": "", "created_at": "2024-06-28T04:33:55.419Z", "modified_at": "2023-04-08T23:58:31.520Z", "type": "github_repository", "description": "eventually holster drab finished than sanity wiggly surprisingly judicious", "selectable": true, "deletable": true, "organization_id": "", "metadata": {"key": false, "key1": 683668, "key2": 4880.9}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "admin"}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Users", "mime_type": "", "size": 789606, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-10-08T06:21:41.000Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2024-12-10T00:21:44.017Z", "size_readable": "", "public_url": "https://poor-duster.name/"}, {"id": "", "organization_id": "", "name": "", "path": "/Users", "mime_type": "", "size": 789606, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-10-08T06:21:41.000Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2024-12-10T00:21:44.017Z", "size_readable": "", "public_url": "https://poor-duster.name/"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-02-06T03:19:32.386Z", "modified_at": "2023-10-17T04:09:43.608Z", "id": "", "metadata": {}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 575720, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2024-02-06T03:19:32.386Z", "modified_at": "2023-10-17T04:09:43.608Z", "id": "", "metadata": {}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 575720, "required": false}]}, "discount": null, "prices": [], "meters": [], "pending_update": {"created_at": "2024-03-15T08:42:29.566Z", "modified_at": "2024-10-27T01:20:21.930Z", "id": "", "applies_at": "2024-04-07T08:09:36.278Z", "product_id": "", "seats": 136029}}} responses: "200": application/json: "" @@ -2172,7 +2188,7 @@ examples: _endpointproduct_created_post: speakeasy-default-endpointproduct-created-post: requestBody: - application/json: {"type": "product.created", "timestamp": "2023-10-13T02:47:55.082Z", "data": {"id": "", "created_at": "2023-10-13T02:47:55.082Z", "modified_at": null, "trial_interval": "day", "trial_interval_count": 168322, "name": "", "description": "till that ew put", "visibility": "draft", "recurring_interval": "month", "recurring_interval_count": 12897, "is_recurring": false, "is_archived": true, "organization_id": "", "metadata": {"key": 785881, "key1": false, "key2": false}, "prices": [{"created_at": "2024-07-28T01:37:16.074Z", "modified_at": "2024-06-21T04:06:38.404Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 351958, "maximum_amount": 675813, "preset_amount": 835712, "legacy": true}, {"created_at": "2024-01-23T05:50:45.318Z", "modified_at": "2024-12-09T02:07:21.938Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}, {"created_at": "2023-09-12T18:18:34.397Z", "modified_at": null, "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 575460, "legacy": true}], "benefits": [{"id": "", "created_at": "2023-01-15T03:15:59.062Z", "modified_at": "2023-07-04T11:33:29.001Z", "type": "discord", "description": "soybean till mortise brr yet sympathetically", "selectable": true, "deletable": true, "organization_id": "", "metadata": {"key": 247381}, "properties": {"guild_id": "", "role_id": "", "kick_member": true, "guild_token": ""}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Users", "mime_type": "", "size": 616062, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-10-29T10:58:55.115Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-02-03T23:25:29.448Z", "size_readable": "", "public_url": "https://livid-stool.biz/"}], "attached_custom_fields": []}} + application/json: {"type": "product.created", "timestamp": "2023-10-13T02:47:55.082Z", "data": {"id": "", "created_at": "2023-10-13T02:47:55.082Z", "modified_at": null, "trial_interval": "day", "trial_interval_count": 168322, "name": "", "description": "till that ew put", "visibility": "draft", "recurring_interval": "month", "recurring_interval_count": 12897, "is_recurring": false, "is_archived": true, "organization_id": "", "metadata": {"key": 785881, "key1": false, "key2": false}, "prices": [{"created_at": "2024-07-28T01:37:16.074Z", "modified_at": "2024-06-21T04:06:38.404Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 351958, "maximum_amount": 675813, "preset_amount": 835712, "legacy": true}, {"created_at": "2024-01-23T05:50:45.318Z", "modified_at": "2024-12-09T02:07:21.938Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "tax_behavior": "location", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}, {"created_at": "2023-09-12T18:18:34.397Z", "modified_at": null, "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 575460, "legacy": true}], "benefits": [{"id": "", "created_at": "2023-01-15T03:15:59.062Z", "modified_at": "2023-07-04T11:33:29.001Z", "type": "discord", "description": "soybean till mortise brr yet sympathetically", "selectable": true, "deletable": true, "organization_id": "", "metadata": {"key": 247381}, "properties": {"guild_id": "", "role_id": "", "kick_member": true, "guild_token": ""}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Users", "mime_type": "", "size": 616062, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-10-29T10:58:55.115Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-02-03T23:25:29.448Z", "size_readable": "", "public_url": "https://livid-stool.biz/"}], "attached_custom_fields": []}} responses: "200": application/json: "" @@ -2181,7 +2197,7 @@ examples: _endpointproduct_updated_post: speakeasy-default-endpointproduct-updated-post: requestBody: - application/json: {"type": "product.updated", "timestamp": "2024-08-25T02:00:54.049Z", "data": {"id": "", "created_at": "2024-08-25T02:00:54.049Z", "modified_at": "2023-07-21T03:22:42.071Z", "trial_interval": "month", "trial_interval_count": 860221, "name": "", "description": "fooey optimistic beyond dress helpfully whispered structure heartfelt consequently", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 705076, "is_recurring": false, "is_archived": false, "organization_id": "", "metadata": {"key": 495401, "key1": true}, "prices": [{"created_at": "2023-07-21T03:22:42.071Z", "modified_at": "2025-05-10T05:05:05.968Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2023-08-10T13:22:51.241Z", "modified_at": "2024-10-05T01:46:47.680Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 753291, "maximum_amount": 103642, "preset_amount": 38424, "legacy": true}, {"created_at": "2024-11-15T20:13:31.076Z", "modified_at": "2025-08-03T01:42:10.311Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 586326, "maximum_amount": 272075, "preset_amount": 946258, "legacy": true}], "benefits": [{"id": "", "created_at": "2024-12-26T20:43:42.655Z", "modified_at": "2023-11-13T02:29:49.304Z", "type": "downloadables", "description": "towards avaricious oof after nutritious", "selectable": true, "deletable": true, "organization_id": "", "metadata": {}, "properties": {"archived": {"key": false}, "files": ["", "", ""]}}, {"id": "", "created_at": "2023-09-18T01:08:29.935Z", "modified_at": "2025-06-15T04:30:20.706Z", "type": "meter_credit", "description": "where patroller after aw arid", "selectable": false, "deletable": true, "organization_id": "", "metadata": {"key": true, "key1": ""}, "properties": {"units": 292879, "rollover": true, "meter_id": ""}}, {"id": "", "created_at": "2023-08-06T07:32:57.958Z", "modified_at": "2023-04-29T20:41:41.892Z", "type": "github_repository", "description": "once however abnormally pace wretched presell", "selectable": false, "deletable": true, "organization_id": "", "metadata": {"key": false}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "pull"}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/opt", "mime_type": "", "size": 435627, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-04-14T07:39:07.142Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-04-21T20:24:54.389Z", "size_readable": "", "public_url": "https://uneven-juggernaut.net"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2025-10-22T03:22:15.717Z", "modified_at": "2024-11-21T19:59:56.303Z", "id": "", "metadata": {"key": true, "key1": false}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 876633, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2025-10-22T03:22:15.717Z", "modified_at": "2024-11-21T19:59:56.303Z", "id": "", "metadata": {"key": true, "key1": false}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 876633, "required": true}]}} + application/json: {"type": "product.updated", "timestamp": "2024-08-25T02:00:54.049Z", "data": {"id": "", "created_at": "2024-08-25T02:00:54.049Z", "modified_at": "2023-07-21T03:22:42.071Z", "trial_interval": "month", "trial_interval_count": 860221, "name": "", "description": "fooey optimistic beyond dress helpfully whispered structure heartfelt consequently", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 705076, "is_recurring": false, "is_archived": false, "organization_id": "", "metadata": {"key": 495401, "key1": true}, "prices": [{"created_at": "2023-07-21T03:22:42.071Z", "modified_at": "2025-05-10T05:05:05.968Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2023-08-10T13:22:51.241Z", "modified_at": "2024-10-05T01:46:47.680Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "exclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 753291, "maximum_amount": 103642, "preset_amount": 38424, "legacy": true}, {"created_at": "2024-11-15T20:13:31.076Z", "modified_at": "2025-08-03T01:42:10.311Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 586326, "maximum_amount": 272075, "preset_amount": 946258, "legacy": true}], "benefits": [{"id": "", "created_at": "2024-12-26T20:43:42.655Z", "modified_at": "2023-11-13T02:29:49.304Z", "type": "downloadables", "description": "towards avaricious oof after nutritious", "selectable": true, "deletable": true, "organization_id": "", "metadata": {}, "properties": {"archived": {"key": false}, "files": ["", "", ""]}}, {"id": "", "created_at": "2023-09-18T01:08:29.935Z", "modified_at": "2025-06-15T04:30:20.706Z", "type": "meter_credit", "description": "where patroller after aw arid", "selectable": false, "deletable": true, "organization_id": "", "metadata": {"key": true, "key1": ""}, "properties": {"units": 292879, "rollover": true, "meter_id": ""}}, {"id": "", "created_at": "2023-08-06T07:32:57.958Z", "modified_at": "2023-04-29T20:41:41.892Z", "type": "github_repository", "description": "once however abnormally pace wretched presell", "selectable": false, "deletable": true, "organization_id": "", "metadata": {"key": false}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "pull"}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/opt", "mime_type": "", "size": 435627, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-04-14T07:39:07.142Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-04-21T20:24:54.389Z", "size_readable": "", "public_url": "https://uneven-juggernaut.net"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2025-10-22T03:22:15.717Z", "modified_at": "2024-11-21T19:59:56.303Z", "id": "", "metadata": {"key": true, "key1": false}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 876633, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2025-10-22T03:22:15.717Z", "modified_at": "2024-11-21T19:59:56.303Z", "id": "", "metadata": {"key": true, "key1": false}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 876633, "required": true}]}} responses: "200": application/json: "" @@ -2190,7 +2206,7 @@ examples: _endpointorganization_updated_post: speakeasy-default-endpointorganization-updated-post: requestBody: - application/json: {"type": "organization.updated", "timestamp": "2025-08-19T15:02:44.139Z", "data": {"created_at": "2025-08-19T15:02:44.139Z", "modified_at": "2025-08-23T00:45:50.780Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": null, "proration_behavior": "prorate", "allow_customer_updates": false, "email": "Lemuel44@gmail.com", "website": "", "socials": [{"platform": "tiktok", "url": "https://grizzled-patroller.info/"}, {"platform": "tiktok", "url": "https://grizzled-patroller.info/"}], "status": "active", "details_submitted_at": null, "default_presentment_currency": "", "feature_settings": {"issue_funding_enabled": false, "seat_based_pricing_enabled": false, "revops_enabled": false, "wallets_enabled": false, "member_model_enabled": false, "tinybird_read": false, "tinybird_compare": false, "checkout_localization_enabled": false}, "subscription_settings": {"allow_multiple_subscriptions": true, "allow_customer_updates": false, "proration_behavior": "invoice", "benefit_revocation_grace_period": 877397, "prevent_trial_abuse": false}, "notification_settings": {"new_order": false, "new_subscription": false}, "customer_email_settings": {"order_confirmation": false, "subscription_cancellation": false, "subscription_confirmation": false, "subscription_cycled": true, "subscription_cycled_after_trial": false, "subscription_past_due": true, "subscription_revoked": true, "subscription_uncanceled": false, "subscription_updated": true}, "customer_portal_settings": {"usage": {"show": true}, "subscription": {"update_seats": true, "update_plan": true}}}} + application/json: {"type": "organization.updated", "timestamp": "2025-08-19T15:02:44.139Z", "data": {"created_at": "2025-08-19T15:02:44.139Z", "modified_at": "2025-08-23T00:45:50.780Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": null, "proration_behavior": "prorate", "allow_customer_updates": false, "email": "Lemuel44@gmail.com", "website": "", "socials": [{"platform": "tiktok", "url": "https://grizzled-patroller.info/"}, {"platform": "tiktok", "url": "https://grizzled-patroller.info/"}], "status": "active", "details_submitted_at": null, "default_presentment_currency": "", "default_tax_behavior": "exclusive", "feature_settings": {"issue_funding_enabled": false, "seat_based_pricing_enabled": false, "revops_enabled": false, "wallets_enabled": false, "member_model_enabled": false, "tinybird_read": false, "tinybird_compare": false, "checkout_localization_enabled": false}, "subscription_settings": {"allow_multiple_subscriptions": true, "allow_customer_updates": false, "proration_behavior": "invoice", "benefit_revocation_grace_period": 877397, "prevent_trial_abuse": false}, "notification_settings": {"new_order": false, "new_subscription": false}, "customer_email_settings": {"order_confirmation": false, "subscription_cancellation": false, "subscription_confirmation": false, "subscription_cycled": true, "subscription_cycled_after_trial": false, "subscription_past_due": true, "subscription_renewal_reminder": false, "subscription_revoked": true, "subscription_trial_conversion_reminder": false, "subscription_uncanceled": false, "subscription_updated": true}, "customer_portal_settings": {"usage": {"show": true}, "subscription": {"update_seats": true, "update_plan": true}}}} responses: "200": application/json: "" @@ -2267,7 +2283,7 @@ examples: application/json: {"name": "", "slug": ""} responses: "201": - application/json: {"created_at": "2024-12-19T02:20:41.368Z", "modified_at": "2024-07-08T16:38:56.712Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://menacing-draft.net", "proration_behavior": "prorate", "allow_customer_updates": false, "email": "Ursula99@yahoo.com", "website": "", "socials": [{"platform": "facebook", "url": "https://likable-commodity.biz/"}], "status": "denied", "details_submitted_at": "2024-04-04T18:10:47.254Z", "default_presentment_currency": "", "feature_settings": {"issue_funding_enabled": false, "seat_based_pricing_enabled": false, "revops_enabled": false, "wallets_enabled": false, "member_model_enabled": false, "tinybird_read": false, "tinybird_compare": false, "checkout_localization_enabled": false}, "subscription_settings": {"allow_multiple_subscriptions": false, "allow_customer_updates": true, "proration_behavior": "prorate", "benefit_revocation_grace_period": 655199, "prevent_trial_abuse": false}, "notification_settings": {"new_order": false, "new_subscription": false}, "customer_email_settings": {"order_confirmation": false, "subscription_cancellation": false, "subscription_confirmation": false, "subscription_cycled": false, "subscription_cycled_after_trial": false, "subscription_past_due": false, "subscription_revoked": false, "subscription_uncanceled": true, "subscription_updated": false}, "customer_portal_settings": {"usage": {"show": false}, "subscription": {"update_seats": false, "update_plan": false}}} + application/json: {"created_at": "2024-12-19T02:20:41.368Z", "modified_at": "2024-07-08T16:38:56.712Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://menacing-draft.net", "proration_behavior": "prorate", "allow_customer_updates": false, "email": "Ursula99@yahoo.com", "website": "", "socials": [{"platform": "facebook", "url": "https://likable-commodity.biz/"}], "status": "denied", "details_submitted_at": "2024-04-04T18:10:47.254Z", "default_presentment_currency": "", "default_tax_behavior": "inclusive", "feature_settings": {"issue_funding_enabled": false, "seat_based_pricing_enabled": false, "revops_enabled": false, "wallets_enabled": false, "member_model_enabled": false, "tinybird_read": false, "tinybird_compare": false, "checkout_localization_enabled": false}, "subscription_settings": {"allow_multiple_subscriptions": false, "allow_customer_updates": true, "proration_behavior": "prorate", "benefit_revocation_grace_period": 655199, "prevent_trial_abuse": false}, "notification_settings": {"new_order": false, "new_subscription": false}, "customer_email_settings": {"order_confirmation": false, "subscription_cancellation": false, "subscription_confirmation": false, "subscription_cycled": false, "subscription_cycled_after_trial": false, "subscription_past_due": false, "subscription_renewal_reminder": false, "subscription_revoked": false, "subscription_trial_conversion_reminder": false, "subscription_uncanceled": true, "subscription_updated": false}, "customer_portal_settings": {"usage": {"show": false}, "subscription": {"update_seats": false, "update_plan": false}}} "422": application/json: {} organizations:get: @@ -2277,7 +2293,7 @@ examples: id: "1dbfc517-0bbf-4301-9ba8-555ca42b9737" responses: "200": - application/json: {"created_at": "2024-06-18T23:12:24.609Z", "modified_at": "2023-11-22T07:49:02.109Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://far-off-resource.com", "proration_behavior": "invoice", "allow_customer_updates": true, "email": "Dejon.Jakubowski-Bashirian6@gmail.com", "website": null, "socials": [{"platform": "other", "url": "https://tedious-habit.com"}, {"platform": "other", "url": "https://tedious-habit.com"}, {"platform": "other", "url": "https://tedious-habit.com"}], "status": "onboarding_started", "details_submitted_at": "2023-07-16T01:59:28.607Z", "default_presentment_currency": "", "feature_settings": {"issue_funding_enabled": false, "seat_based_pricing_enabled": false, "revops_enabled": false, "wallets_enabled": false, "member_model_enabled": false, "tinybird_read": false, "tinybird_compare": false, "checkout_localization_enabled": false}, "subscription_settings": {"allow_multiple_subscriptions": true, "allow_customer_updates": false, "proration_behavior": "prorate", "benefit_revocation_grace_period": 488109, "prevent_trial_abuse": false}, "notification_settings": {"new_order": true, "new_subscription": true}, "customer_email_settings": {"order_confirmation": true, "subscription_cancellation": true, "subscription_confirmation": true, "subscription_cycled": false, "subscription_cycled_after_trial": true, "subscription_past_due": false, "subscription_revoked": true, "subscription_uncanceled": false, "subscription_updated": true}, "customer_portal_settings": {"usage": {"show": false}, "subscription": {"update_seats": true, "update_plan": false}}} + application/json: {"created_at": "2024-06-18T23:12:24.609Z", "modified_at": "2023-11-22T07:49:02.109Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://far-off-resource.com", "proration_behavior": "invoice", "allow_customer_updates": true, "email": "Dejon.Jakubowski-Bashirian6@gmail.com", "website": null, "socials": [{"platform": "other", "url": "https://tedious-habit.com"}, {"platform": "other", "url": "https://tedious-habit.com"}, {"platform": "other", "url": "https://tedious-habit.com"}], "status": "onboarding_started", "details_submitted_at": "2023-07-16T01:59:28.607Z", "default_presentment_currency": "", "default_tax_behavior": "inclusive", "feature_settings": {"issue_funding_enabled": false, "seat_based_pricing_enabled": false, "revops_enabled": false, "wallets_enabled": false, "member_model_enabled": false, "tinybird_read": false, "tinybird_compare": false, "checkout_localization_enabled": false}, "subscription_settings": {"allow_multiple_subscriptions": true, "allow_customer_updates": false, "proration_behavior": "prorate", "benefit_revocation_grace_period": 488109, "prevent_trial_abuse": false}, "notification_settings": {"new_order": true, "new_subscription": true}, "customer_email_settings": {"order_confirmation": true, "subscription_cancellation": true, "subscription_confirmation": true, "subscription_cycled": false, "subscription_cycled_after_trial": true, "subscription_past_due": false, "subscription_renewal_reminder": true, "subscription_revoked": true, "subscription_trial_conversion_reminder": true, "subscription_uncanceled": false, "subscription_updated": true}, "customer_portal_settings": {"usage": {"show": false}, "subscription": {"update_seats": true, "update_plan": false}}} "404": application/json: {"error": "ResourceNotFound", "detail": ""} "422": @@ -2291,7 +2307,7 @@ examples: application/json: {} responses: "200": - application/json: {"created_at": "2024-01-10T12:09:47.665Z", "modified_at": "2025-07-12T14:18:16.022Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://juvenile-deed.name/", "proration_behavior": "invoice", "allow_customer_updates": false, "email": "Stanford.Streich62@gmail.com", "website": "", "socials": [{"platform": "github", "url": "https://violent-ownership.org/"}], "status": "onboarding_started", "details_submitted_at": "2024-05-08T13:53:13.516Z", "default_presentment_currency": "", "feature_settings": {"issue_funding_enabled": false, "seat_based_pricing_enabled": false, "revops_enabled": false, "wallets_enabled": false, "member_model_enabled": false, "tinybird_read": false, "tinybird_compare": false, "checkout_localization_enabled": false}, "subscription_settings": {"allow_multiple_subscriptions": false, "allow_customer_updates": false, "proration_behavior": "invoice", "benefit_revocation_grace_period": 341703, "prevent_trial_abuse": false}, "notification_settings": {"new_order": true, "new_subscription": false}, "customer_email_settings": {"order_confirmation": true, "subscription_cancellation": false, "subscription_confirmation": false, "subscription_cycled": false, "subscription_cycled_after_trial": true, "subscription_past_due": true, "subscription_revoked": true, "subscription_uncanceled": true, "subscription_updated": false}, "customer_portal_settings": {"usage": {"show": false}, "subscription": {"update_seats": true, "update_plan": true}}} + application/json: {"created_at": "2024-01-10T12:09:47.665Z", "modified_at": "2025-07-12T14:18:16.022Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://juvenile-deed.name/", "proration_behavior": "invoice", "allow_customer_updates": false, "email": "Stanford.Streich62@gmail.com", "website": "", "socials": [{"platform": "github", "url": "https://violent-ownership.org/"}], "status": "onboarding_started", "details_submitted_at": "2024-05-08T13:53:13.516Z", "default_presentment_currency": "", "default_tax_behavior": "inclusive", "feature_settings": {"issue_funding_enabled": false, "seat_based_pricing_enabled": false, "revops_enabled": false, "wallets_enabled": false, "member_model_enabled": false, "tinybird_read": false, "tinybird_compare": false, "checkout_localization_enabled": false}, "subscription_settings": {"allow_multiple_subscriptions": false, "allow_customer_updates": false, "proration_behavior": "invoice", "benefit_revocation_grace_period": 341703, "prevent_trial_abuse": false}, "notification_settings": {"new_order": true, "new_subscription": false}, "customer_email_settings": {"order_confirmation": true, "subscription_cancellation": false, "subscription_confirmation": false, "subscription_cycled": false, "subscription_cycled_after_trial": true, "subscription_past_due": true, "subscription_renewal_reminder": false, "subscription_revoked": true, "subscription_trial_conversion_reminder": false, "subscription_uncanceled": true, "subscription_updated": false}, "customer_portal_settings": {"usage": {"show": false}, "subscription": {"update_seats": true, "update_plan": true}}} "403": application/json: {"error": "NotPermitted", "detail": ""} "404": @@ -2307,7 +2323,7 @@ examples: limit: 10 responses: "200": - application/json: {"items": [{"created_at": "2024-11-06T13:01:30.486Z", "modified_at": "2024-03-26T10:08:00.196Z", "id": "", "amount": 492124, "currency": "Rial Omani", "recurring_interval": "year", "recurring_interval_count": 742797, "status": "canceled", "current_period_start": "2025-09-23T15:13:06.761Z", "current_period_end": "2023-09-22T22:50:40.236Z", "trial_start": "2024-10-01T10:10:26.018Z", "trial_end": "2023-12-05T04:37:49.573Z", "cancel_at_period_end": true, "canceled_at": "2024-06-12T10:43:36.497Z", "started_at": "2025-03-14T07:47:35.696Z", "ends_at": "2025-07-03T16:46:46.137Z", "ended_at": "2024-03-20T05:19:38.088Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "low_quality", "customer_cancellation_comment": "", "metadata": {"key": true, "key1": 142409}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2023-08-24T17:03:16.161Z", "modified_at": "2025-05-07T18:20:34.107Z", "metadata": {}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "name": "John Doe", "billing_address": null, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2025-06-25T13:44:42.918Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=blank"}, "product": {"id": "", "created_at": "2024-12-09T00:06:17.749Z", "modified_at": "2025-08-24T16:27:54.472Z", "trial_interval": "week", "trial_interval_count": 960252, "name": "", "description": "er making aha doing offset oh incidentally aside hm", "visibility": "public", "recurring_interval": "year", "recurring_interval_count": 616371, "is_recurring": true, "is_archived": true, "organization_id": "", "metadata": {"key": false, "key1": false, "key2": false}, "prices": [], "benefits": [{"id": "", "created_at": "2025-04-05T16:53:07.702Z", "modified_at": "2024-05-11T08:58:06.412Z", "type": "custom", "description": "border pink insert sonnet membership access made-up aha an", "selectable": false, "deletable": true, "organization_id": "", "metadata": {"key": ""}, "properties": {"note": ""}}, {"id": "", "created_at": "2025-05-20T14:55:17.223Z", "modified_at": "2025-04-09T10:13:23.999Z", "type": "github_repository", "description": "quarrelsome joyously diligently mmm joshingly sailor or jury annex", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 810447, "key1": 8377.26, "key2": 623085}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "push"}}, {"id": "", "created_at": "2025-05-20T14:55:17.223Z", "modified_at": "2025-04-09T10:13:23.999Z", "type": "github_repository", "description": "quarrelsome joyously diligently mmm joshingly sailor or jury annex", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 810447, "key1": 8377.26, "key2": 623085}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "push"}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/opt/include", "mime_type": "", "size": 39873, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-10-09T14:35:38.900Z", "version": null, "service": "product_media", "is_uploaded": false, "created_at": "2023-06-02T18:03:00.031Z", "size_readable": "", "public_url": "https://aggravating-graffiti.info/"}, {"id": "", "organization_id": "", "name": "", "path": "/opt/include", "mime_type": "", "size": 39873, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-10-09T14:35:38.900Z", "version": null, "service": "product_media", "is_uploaded": false, "created_at": "2023-06-02T18:03:00.031Z", "size_readable": "", "public_url": "https://aggravating-graffiti.info/"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-08-14T02:26:18.152Z", "modified_at": null, "id": "", "metadata": {"key": 496263, "key1": "", "key2": ""}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 561607, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2024-08-14T02:26:18.152Z", "modified_at": null, "id": "", "metadata": {"key": 496263, "key1": "", "key2": ""}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 561607, "required": false}]}, "discount": {"duration": "forever", "type": "percentage", "basis_points": 1000, "created_at": "2024-12-04T04:37:49.573Z", "modified_at": "2025-06-23T08:50:11.993Z", "id": "", "metadata": {"key": false}, "name": "", "code": "", "starts_at": "2024-09-21T22:50:40.236Z", "ends_at": "2026-05-03T04:33:34.190Z", "max_redemptions": 265915, "redemptions_count": 732961, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [{"created_at": "2024-11-06T13:01:30.486Z", "modified_at": "2024-03-26T10:08:00.196Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2023-09-22T22:50:40.236Z", "modified_at": "2025-05-03T04:33:34.190Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 834580, "legacy": true}], "meters": []}, {"created_at": "2024-11-06T13:01:30.486Z", "modified_at": "2024-03-26T10:08:00.196Z", "id": "", "amount": 492124, "currency": "Rial Omani", "recurring_interval": "year", "recurring_interval_count": 308570, "status": "canceled", "current_period_start": "2025-09-23T15:13:06.761Z", "current_period_end": "2023-09-22T22:50:40.236Z", "trial_start": "2025-09-23T15:13:06.761Z", "trial_end": "2023-09-22T22:50:40.236Z", "cancel_at_period_end": true, "canceled_at": "2024-06-12T10:43:36.497Z", "started_at": "2025-03-14T07:47:35.696Z", "ends_at": "2025-07-03T16:46:46.137Z", "ended_at": "2024-03-20T05:19:38.088Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "low_quality", "customer_cancellation_comment": "", "metadata": {"key": true, "key1": 142409}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2023-08-24T17:03:16.161Z", "modified_at": "2025-05-07T18:20:34.107Z", "metadata": {}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "name": "John Doe", "billing_address": null, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2025-06-25T13:44:42.918Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=blank"}, "product": {"id": "", "created_at": "2024-12-09T00:06:17.749Z", "modified_at": "2025-08-24T16:27:54.472Z", "trial_interval": "year", "trial_interval_count": 265915, "name": "", "description": "er making aha doing offset oh incidentally aside hm", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 492124, "is_recurring": true, "is_archived": true, "organization_id": "", "metadata": {"key": false, "key1": false, "key2": false}, "prices": [], "benefits": [{"id": "", "created_at": "2025-04-05T16:53:07.702Z", "modified_at": "2024-05-11T08:58:06.412Z", "type": "custom", "description": "border pink insert sonnet membership access made-up aha an", "selectable": false, "deletable": true, "organization_id": "", "metadata": {"key": ""}, "properties": {"note": ""}}, {"id": "", "created_at": "2025-05-20T14:55:17.223Z", "modified_at": "2025-04-09T10:13:23.999Z", "type": "github_repository", "description": "quarrelsome joyously diligently mmm joshingly sailor or jury annex", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 810447, "key1": 8377.26, "key2": 623085}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "push"}}, {"id": "", "created_at": "2025-05-20T14:55:17.223Z", "modified_at": "2025-04-09T10:13:23.999Z", "type": "github_repository", "description": "quarrelsome joyously diligently mmm joshingly sailor or jury annex", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 810447, "key1": 8377.26, "key2": 623085}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "push"}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/opt/include", "mime_type": "", "size": 39873, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-10-09T14:35:38.900Z", "version": null, "service": "product_media", "is_uploaded": false, "created_at": "2023-06-02T18:03:00.031Z", "size_readable": "", "public_url": "https://aggravating-graffiti.info/"}, {"id": "", "organization_id": "", "name": "", "path": "/opt/include", "mime_type": "", "size": 39873, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-10-09T14:35:38.900Z", "version": null, "service": "product_media", "is_uploaded": false, "created_at": "2023-06-02T18:03:00.031Z", "size_readable": "", "public_url": "https://aggravating-graffiti.info/"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-08-14T02:26:18.152Z", "modified_at": null, "id": "", "metadata": {"key": 496263, "key1": "", "key2": ""}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 561607, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2024-08-14T02:26:18.152Z", "modified_at": null, "id": "", "metadata": {"key": 496263, "key1": "", "key2": ""}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 561607, "required": false}]}, "discount": {"duration": "repeating", "duration_in_months": 786734, "type": "fixed", "basis_points": 1000, "created_at": "2026-04-30T02:52:35.936Z", "modified_at": "2024-10-28T13:21:35.872Z", "id": "", "metadata": {}, "name": "", "code": "", "starts_at": "2026-09-12T12:57:56.639Z", "ends_at": "2024-11-10T17:51:02.571Z", "max_redemptions": 215064, "redemptions_count": 776767, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [{"created_at": "2025-04-30T02:52:35.936Z", "modified_at": "2023-10-29T13:21:35.872Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 262272, "legacy": true}, {"created_at": "2023-08-24T17:03:16.161Z", "modified_at": "2025-05-07T18:20:34.107Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 827165, "maximum_amount": 310545, "preset_amount": 154160, "legacy": true}], "meters": []}], "pagination": {"total_count": 947589, "max_page": 388476}} + application/json: {"items": [{"created_at": "2024-11-06T13:01:30.486Z", "modified_at": "2024-03-26T10:08:00.196Z", "id": "", "amount": 492124, "currency": "Rial Omani", "recurring_interval": "year", "recurring_interval_count": 742797, "status": "canceled", "current_period_start": "2025-09-23T15:13:06.761Z", "current_period_end": "2023-09-22T22:50:40.236Z", "trial_start": "2024-10-01T10:10:26.018Z", "trial_end": "2023-12-05T04:37:49.573Z", "cancel_at_period_end": true, "canceled_at": "2024-06-12T10:43:36.497Z", "started_at": "2025-03-14T07:47:35.696Z", "ends_at": "2025-07-03T16:46:46.137Z", "ended_at": "2024-03-20T05:19:38.088Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "low_quality", "customer_cancellation_comment": "", "metadata": {"key": true, "key1": 142409}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2023-08-24T17:03:16.161Z", "modified_at": "2025-05-07T18:20:34.107Z", "metadata": {}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "name": "John Doe", "billing_address": null, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2025-06-25T13:44:42.918Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=blank"}, "product": {"id": "", "created_at": "2024-12-09T00:06:17.749Z", "modified_at": "2025-08-24T16:27:54.472Z", "trial_interval": "week", "trial_interval_count": 960252, "name": "", "description": "er making aha doing offset oh incidentally aside hm", "visibility": "public", "recurring_interval": "year", "recurring_interval_count": 616371, "is_recurring": true, "is_archived": true, "organization_id": "", "metadata": {"key": false, "key1": false, "key2": false}, "prices": [], "benefits": [{"id": "", "created_at": "2025-04-05T16:53:07.702Z", "modified_at": "2024-05-11T08:58:06.412Z", "type": "custom", "description": "border pink insert sonnet membership access made-up aha an", "selectable": false, "deletable": true, "organization_id": "", "metadata": {"key": ""}, "properties": {"note": ""}}, {"id": "", "created_at": "2025-05-20T14:55:17.223Z", "modified_at": "2025-04-09T10:13:23.999Z", "type": "github_repository", "description": "quarrelsome joyously diligently mmm joshingly sailor or jury annex", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 810447, "key1": 8377.26, "key2": 623085}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "push"}}, {"id": "", "created_at": "2025-05-20T14:55:17.223Z", "modified_at": "2025-04-09T10:13:23.999Z", "type": "github_repository", "description": "quarrelsome joyously diligently mmm joshingly sailor or jury annex", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 810447, "key1": 8377.26, "key2": 623085}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "push"}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/opt/include", "mime_type": "", "size": 39873, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-10-09T14:35:38.900Z", "version": null, "service": "product_media", "is_uploaded": false, "created_at": "2023-06-02T18:03:00.031Z", "size_readable": "", "public_url": "https://aggravating-graffiti.info/"}, {"id": "", "organization_id": "", "name": "", "path": "/opt/include", "mime_type": "", "size": 39873, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-10-09T14:35:38.900Z", "version": null, "service": "product_media", "is_uploaded": false, "created_at": "2023-06-02T18:03:00.031Z", "size_readable": "", "public_url": "https://aggravating-graffiti.info/"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-08-14T02:26:18.152Z", "modified_at": null, "id": "", "metadata": {"key": 496263, "key1": "", "key2": ""}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 561607, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2024-08-14T02:26:18.152Z", "modified_at": null, "id": "", "metadata": {"key": 496263, "key1": "", "key2": ""}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 561607, "required": false}]}, "discount": {"duration": "forever", "type": "percentage", "basis_points": 1000, "created_at": "2024-12-04T04:37:49.573Z", "modified_at": "2025-06-23T08:50:11.993Z", "id": "", "metadata": {"key": false}, "name": "", "code": "", "starts_at": "2024-09-21T22:50:40.236Z", "ends_at": "2026-05-03T04:33:34.190Z", "max_redemptions": 265915, "redemptions_count": 732961, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [{"created_at": "2024-11-06T13:01:30.486Z", "modified_at": "2024-03-26T10:08:00.196Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "tax_behavior": "inclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2023-09-22T22:50:40.236Z", "modified_at": "2025-05-03T04:33:34.190Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 834580, "legacy": true}], "meters": [], "pending_update": {"created_at": "2025-06-23T08:50:11.993Z", "modified_at": "2026-11-18T10:27:58.317Z", "id": "", "applies_at": "2026-04-10T00:55:03.476Z", "product_id": "", "seats": 241744}}, {"created_at": "2024-11-06T13:01:30.486Z", "modified_at": "2024-03-26T10:08:00.196Z", "id": "", "amount": 492124, "currency": "Rial Omani", "recurring_interval": "year", "recurring_interval_count": 308570, "status": "canceled", "current_period_start": "2025-09-23T15:13:06.761Z", "current_period_end": "2023-09-22T22:50:40.236Z", "trial_start": "2025-09-23T15:13:06.761Z", "trial_end": "2023-09-22T22:50:40.236Z", "cancel_at_period_end": true, "canceled_at": "2024-06-12T10:43:36.497Z", "started_at": "2025-03-14T07:47:35.696Z", "ends_at": "2025-07-03T16:46:46.137Z", "ended_at": "2024-03-20T05:19:38.088Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "low_quality", "customer_cancellation_comment": "", "metadata": {"key": true, "key1": 142409}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2023-08-24T17:03:16.161Z", "modified_at": "2025-05-07T18:20:34.107Z", "metadata": {}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "name": "John Doe", "billing_address": null, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2025-06-25T13:44:42.918Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=blank"}, "product": {"id": "", "created_at": "2024-12-09T00:06:17.749Z", "modified_at": "2025-08-24T16:27:54.472Z", "trial_interval": "year", "trial_interval_count": 265915, "name": "", "description": "er making aha doing offset oh incidentally aside hm", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 492124, "is_recurring": true, "is_archived": true, "organization_id": "", "metadata": {"key": false, "key1": false, "key2": false}, "prices": [], "benefits": [{"id": "", "created_at": "2025-04-05T16:53:07.702Z", "modified_at": "2024-05-11T08:58:06.412Z", "type": "custom", "description": "border pink insert sonnet membership access made-up aha an", "selectable": false, "deletable": true, "organization_id": "", "metadata": {"key": ""}, "properties": {"note": ""}}, {"id": "", "created_at": "2025-05-20T14:55:17.223Z", "modified_at": "2025-04-09T10:13:23.999Z", "type": "github_repository", "description": "quarrelsome joyously diligently mmm joshingly sailor or jury annex", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 810447, "key1": 8377.26, "key2": 623085}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "push"}}, {"id": "", "created_at": "2025-05-20T14:55:17.223Z", "modified_at": "2025-04-09T10:13:23.999Z", "type": "github_repository", "description": "quarrelsome joyously diligently mmm joshingly sailor or jury annex", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 810447, "key1": 8377.26, "key2": 623085}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "push"}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/opt/include", "mime_type": "", "size": 39873, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-10-09T14:35:38.900Z", "version": null, "service": "product_media", "is_uploaded": false, "created_at": "2023-06-02T18:03:00.031Z", "size_readable": "", "public_url": "https://aggravating-graffiti.info/"}, {"id": "", "organization_id": "", "name": "", "path": "/opt/include", "mime_type": "", "size": 39873, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-10-09T14:35:38.900Z", "version": null, "service": "product_media", "is_uploaded": false, "created_at": "2023-06-02T18:03:00.031Z", "size_readable": "", "public_url": "https://aggravating-graffiti.info/"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-08-14T02:26:18.152Z", "modified_at": null, "id": "", "metadata": {"key": 496263, "key1": "", "key2": ""}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 561607, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2024-08-14T02:26:18.152Z", "modified_at": null, "id": "", "metadata": {"key": 496263, "key1": "", "key2": ""}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 561607, "required": false}]}, "discount": {"duration": "repeating", "duration_in_months": 786734, "type": "fixed", "basis_points": 1000, "created_at": "2026-04-30T02:52:35.936Z", "modified_at": "2024-10-28T13:21:35.872Z", "id": "", "metadata": {}, "name": "", "code": "", "starts_at": "2026-09-12T12:57:56.639Z", "ends_at": "2024-11-10T17:51:02.571Z", "max_redemptions": 215064, "redemptions_count": 776767, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [{"created_at": "2025-04-30T02:52:35.936Z", "modified_at": "2023-10-29T13:21:35.872Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "tax_behavior": "exclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 262272, "legacy": true}, {"created_at": "2023-08-24T17:03:16.161Z", "modified_at": "2025-05-07T18:20:34.107Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 827165, "maximum_amount": 310545, "preset_amount": 154160, "legacy": true}], "meters": [], "pending_update": {"created_at": "2025-06-23T08:50:11.993Z", "modified_at": "2026-11-18T10:27:58.317Z", "id": "", "applies_at": "2026-04-10T00:55:03.476Z", "product_id": "", "seats": 241744}}], "pagination": {"total_count": 947589, "max_page": 388476}} "422": application/json: {} subscriptions:export: @@ -2328,7 +2344,7 @@ examples: id: "" responses: "200": - application/json: {"created_at": "2023-10-24T15:26:40.431Z", "modified_at": "2023-07-28T23:00:02.724Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "year", "recurring_interval_count": 270660, "status": "active", "current_period_start": "2025-04-05T21:01:12.454Z", "current_period_end": "2024-10-23T15:26:40.431Z", "trial_start": "2024-06-09T21:26:52.968Z", "trial_end": "2025-09-03T08:50:28.234Z", "cancel_at_period_end": true, "canceled_at": "2025-05-09T12:42:07.453Z", "started_at": "2025-12-16T12:13:32.171Z", "ends_at": "2025-07-23T18:45:11.258Z", "ended_at": null, "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": null, "customer_cancellation_comment": "", "metadata": {}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2025-06-01T00:25:19.556Z", "modified_at": null, "metadata": {"key": 8941.51, "key1": 393.1}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2024-03-15T13:55:38.252Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2024-04-22T11:34:07.174Z", "modified_at": "2024-01-28T05:15:18.595Z", "trial_interval": "year", "trial_interval_count": 753537, "name": "", "description": "solder crossly except yet", "visibility": "draft", "recurring_interval": null, "recurring_interval_count": 190655, "is_recurring": false, "is_archived": false, "organization_id": "", "metadata": {}, "prices": [{"created_at": "2023-07-28T23:00:02.724Z", "modified_at": "2025-03-22T08:23:39.797Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 753537, "legacy": true}, {"created_at": "2023-10-17T03:10:19.145Z", "modified_at": "2024-12-02T16:50:43.309Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 852903, "legacy": true}], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/var/mail", "mime_type": "", "size": 768823, "storage_version": "", "checksum_etag": null, "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-11-22T03:27:39.662Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-06-30T04:51:26.931Z", "size_readable": "", "public_url": "https://gigantic-spring.name/"}, {"id": "", "organization_id": "", "name": "", "path": "/var/mail", "mime_type": "", "size": 768823, "storage_version": "", "checksum_etag": null, "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-11-22T03:27:39.662Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-06-30T04:51:26.931Z", "size_readable": "", "public_url": "https://gigantic-spring.name/"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-08-20T15:07:05.822Z", "modified_at": "2025-07-11T03:45:02.430Z", "id": "", "metadata": {}, "type": "checkbox", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 61252, "required": true}]}, "discount": {"duration": "once", "duration_in_months": 342177, "type": "fixed", "amount": 861306, "currency": "CFA Franc BCEAO", "amounts": {"eur": 900, "usd": 1000}, "created_at": "2023-04-20T11:08:19.373Z", "modified_at": "2023-06-26T04:56:35.602Z", "id": "", "metadata": {}, "name": "", "code": "", "starts_at": "2023-05-19T07:23:10.203Z", "ends_at": null, "max_redemptions": 381050, "redemptions_count": 60295, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [], "meters": []} + application/json: {"created_at": "2023-10-24T15:26:40.431Z", "modified_at": "2023-07-28T23:00:02.724Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "year", "recurring_interval_count": 270660, "status": "active", "current_period_start": "2025-04-05T21:01:12.454Z", "current_period_end": "2024-10-23T15:26:40.431Z", "trial_start": "2024-06-09T21:26:52.968Z", "trial_end": "2025-09-03T08:50:28.234Z", "cancel_at_period_end": true, "canceled_at": "2025-05-09T12:42:07.453Z", "started_at": "2025-12-16T12:13:32.171Z", "ends_at": "2025-07-23T18:45:11.258Z", "ended_at": null, "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": null, "customer_cancellation_comment": "", "metadata": {}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2025-06-01T00:25:19.556Z", "modified_at": null, "metadata": {"key": 8941.51, "key1": 393.1}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2024-03-15T13:55:38.252Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2024-04-22T11:34:07.174Z", "modified_at": "2024-01-28T05:15:18.595Z", "trial_interval": "year", "trial_interval_count": 753537, "name": "", "description": "solder crossly except yet", "visibility": "draft", "recurring_interval": null, "recurring_interval_count": 190655, "is_recurring": false, "is_archived": false, "organization_id": "", "metadata": {}, "prices": [{"created_at": "2023-07-28T23:00:02.724Z", "modified_at": "2025-03-22T08:23:39.797Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 753537, "legacy": true}, {"created_at": "2023-10-17T03:10:19.145Z", "modified_at": "2024-12-02T16:50:43.309Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 852903, "legacy": true}], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/var/mail", "mime_type": "", "size": 768823, "storage_version": "", "checksum_etag": null, "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-11-22T03:27:39.662Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-06-30T04:51:26.931Z", "size_readable": "", "public_url": "https://gigantic-spring.name/"}, {"id": "", "organization_id": "", "name": "", "path": "/var/mail", "mime_type": "", "size": 768823, "storage_version": "", "checksum_etag": null, "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-11-22T03:27:39.662Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-06-30T04:51:26.931Z", "size_readable": "", "public_url": "https://gigantic-spring.name/"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-08-20T15:07:05.822Z", "modified_at": "2025-07-11T03:45:02.430Z", "id": "", "metadata": {}, "type": "checkbox", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 61252, "required": true}]}, "discount": {"duration": "once", "duration_in_months": 342177, "type": "fixed", "amount": 861306, "currency": "CFA Franc BCEAO", "amounts": {"eur": 900, "usd": 1000}, "created_at": "2023-04-20T11:08:19.373Z", "modified_at": "2023-06-26T04:56:35.602Z", "id": "", "metadata": {}, "name": "", "code": "", "starts_at": "2023-05-19T07:23:10.203Z", "ends_at": null, "max_redemptions": 381050, "redemptions_count": 60295, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [], "meters": [], "pending_update": {"created_at": "2026-09-23T23:03:44.833Z", "modified_at": "2026-04-05T21:01:12.454Z", "id": "", "applies_at": "2024-01-20T10:40:24.645Z", "product_id": "", "seats": 784242}} "404": application/json: {"error": "ResourceNotFound", "detail": ""} "422": @@ -2342,7 +2358,7 @@ examples: application/json: {"product_id": ""} responses: "200": - application/json: {"created_at": "2023-12-04T14:44:14.136Z", "modified_at": "2023-05-01T08:54:32.351Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "year", "recurring_interval_count": 297120, "status": "canceled", "current_period_start": "2024-10-27T19:14:25.505Z", "current_period_end": "2025-11-08T09:51:13.337Z", "trial_start": "2023-12-04T14:44:14.136Z", "trial_end": "2023-05-01T08:54:32.351Z", "cancel_at_period_end": false, "canceled_at": "2023-05-16T23:35:19.423Z", "started_at": "2023-11-02T08:09:24.083Z", "ends_at": "2025-04-12T21:04:51.008Z", "ended_at": "2023-12-10T00:14:34.013Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "missing_features", "customer_cancellation_comment": null, "metadata": {"key": 7847.22, "key1": true}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2024-12-28T05:26:01.320Z", "modified_at": "2023-07-10T03:03:20.499Z", "metadata": {"key": 6844.97}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2025-09-09T13:23:35.812Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2024-08-15T15:06:53.828Z", "modified_at": "2025-03-30T01:15:57.619Z", "trial_interval": "year", "trial_interval_count": 827417, "name": "", "description": null, "visibility": "draft", "recurring_interval": "year", "recurring_interval_count": 891943, "is_recurring": true, "is_archived": true, "organization_id": "", "metadata": {"key": "", "key1": 6842.69}, "prices": [{"created_at": "2025-09-04T13:39:15.428Z", "modified_at": "2023-06-09T23:09:57.743Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 607483, "maximum_amount": 951105, "preset_amount": 838393, "legacy": true}], "benefits": [], "medias": [], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2025-08-28T05:31:36.934Z", "modified_at": "2025-01-12T20:56:10.352Z", "id": "", "metadata": {"key": "", "key1": true}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 610180, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2025-08-28T05:31:36.934Z", "modified_at": "2025-01-12T20:56:10.352Z", "id": "", "metadata": {"key": "", "key1": true}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 610180, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2025-08-28T05:31:36.934Z", "modified_at": "2025-01-12T20:56:10.352Z", "id": "", "metadata": {"key": "", "key1": true}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 610180, "required": true}]}, "discount": {"duration": "forever", "duration_in_months": 913858, "type": "percentage", "amount": 925698, "currency": "Pound Sterling", "amounts": {"eur": 900, "usd": 1000}, "created_at": "2025-01-31T19:57:33.256Z", "modified_at": "2024-11-08T18:43:15.968Z", "id": "", "metadata": {"key": 2646.89}, "name": "", "code": "", "starts_at": "2025-02-01T12:19:14.944Z", "ends_at": "2023-04-23T06:57:38.844Z", "max_redemptions": 467745, "redemptions_count": 167766, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [{"created_at": "2023-11-02T08:09:24.083Z", "modified_at": "2025-04-12T21:04:51.008Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 203413, "legacy": true}, {"created_at": "2024-02-05T08:01:02.549Z", "modified_at": null, "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2023-12-26T01:37:45.354Z", "modified_at": "2023-11-30T02:22:41.602Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 563833, "legacy": true}], "meters": [{"created_at": "2025-04-18T21:57:33.981Z", "modified_at": "2024-10-02T20:14:14.923Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {}, "created_at": "2024-07-09T16:42:12.156Z", "modified_at": "2025-01-04T07:19:55.953Z", "id": "", "name": "", "filter": {"conjunction": "or", "clauses": [{"conjunction": "and", "clauses": []}]}, "aggregation": {"func": "avg", "property": ""}, "organization_id": ""}}, {"created_at": "2025-04-18T21:57:33.981Z", "modified_at": "2024-10-02T20:14:14.923Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {}, "created_at": "2024-07-09T16:42:12.156Z", "modified_at": "2025-01-04T07:19:55.953Z", "id": "", "name": "", "filter": {"conjunction": "or", "clauses": [{"conjunction": "and", "clauses": []}]}, "aggregation": {"func": "avg", "property": ""}, "organization_id": ""}}]} + application/json: {"created_at": "2023-12-04T14:44:14.136Z", "modified_at": "2023-05-01T08:54:32.351Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "year", "recurring_interval_count": 297120, "status": "canceled", "current_period_start": "2024-10-27T19:14:25.505Z", "current_period_end": "2025-11-08T09:51:13.337Z", "trial_start": "2023-12-04T14:44:14.136Z", "trial_end": "2023-05-01T08:54:32.351Z", "cancel_at_period_end": false, "canceled_at": "2023-05-16T23:35:19.423Z", "started_at": "2023-11-02T08:09:24.083Z", "ends_at": "2025-04-12T21:04:51.008Z", "ended_at": "2023-12-10T00:14:34.013Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "missing_features", "customer_cancellation_comment": null, "metadata": {"key": 7847.22, "key1": true}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2024-12-28T05:26:01.320Z", "modified_at": "2023-07-10T03:03:20.499Z", "metadata": {"key": 6844.97}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2025-09-09T13:23:35.812Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2024-08-15T15:06:53.828Z", "modified_at": "2025-03-30T01:15:57.619Z", "trial_interval": "year", "trial_interval_count": 827417, "name": "", "description": null, "visibility": "draft", "recurring_interval": "year", "recurring_interval_count": 891943, "is_recurring": true, "is_archived": true, "organization_id": "", "metadata": {"key": "", "key1": 6842.69}, "prices": [{"created_at": "2025-09-04T13:39:15.428Z", "modified_at": "2023-06-09T23:09:57.743Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 607483, "maximum_amount": 951105, "preset_amount": 838393, "legacy": true}], "benefits": [], "medias": [], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2025-08-28T05:31:36.934Z", "modified_at": "2025-01-12T20:56:10.352Z", "id": "", "metadata": {"key": "", "key1": true}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 610180, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2025-08-28T05:31:36.934Z", "modified_at": "2025-01-12T20:56:10.352Z", "id": "", "metadata": {"key": "", "key1": true}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 610180, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2025-08-28T05:31:36.934Z", "modified_at": "2025-01-12T20:56:10.352Z", "id": "", "metadata": {"key": "", "key1": true}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 610180, "required": true}]}, "discount": {"duration": "forever", "duration_in_months": 913858, "type": "percentage", "amount": 925698, "currency": "Pound Sterling", "amounts": {"eur": 900, "usd": 1000}, "created_at": "2025-01-31T19:57:33.256Z", "modified_at": "2024-11-08T18:43:15.968Z", "id": "", "metadata": {"key": 2646.89}, "name": "", "code": "", "starts_at": "2025-02-01T12:19:14.944Z", "ends_at": "2023-04-23T06:57:38.844Z", "max_redemptions": 467745, "redemptions_count": 167766, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [{"created_at": "2023-11-02T08:09:24.083Z", "modified_at": "2025-04-12T21:04:51.008Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 203413, "legacy": true}, {"created_at": "2024-02-05T08:01:02.549Z", "modified_at": null, "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2023-12-26T01:37:45.354Z", "modified_at": "2023-11-30T02:22:41.602Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 563833, "legacy": true}], "meters": [{"created_at": "2025-04-18T21:57:33.981Z", "modified_at": "2024-10-02T20:14:14.923Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {}, "created_at": "2024-07-09T16:42:12.156Z", "modified_at": "2025-01-04T07:19:55.953Z", "id": "", "name": "", "filter": {"conjunction": "or", "clauses": [{"conjunction": "and", "clauses": []}]}, "aggregation": {"func": "avg", "property": ""}, "organization_id": ""}}, {"created_at": "2025-04-18T21:57:33.981Z", "modified_at": "2024-10-02T20:14:14.923Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {}, "created_at": "2024-07-09T16:42:12.156Z", "modified_at": "2025-01-04T07:19:55.953Z", "id": "", "name": "", "filter": {"conjunction": "or", "clauses": [{"conjunction": "and", "clauses": []}]}, "aggregation": {"func": "avg", "property": ""}, "organization_id": ""}}], "pending_update": {"created_at": "2025-04-18T08:25:13.474Z", "modified_at": "2025-09-07T02:23:54.975Z", "id": "", "applies_at": "2026-07-07T21:05:18.372Z", "product_id": "", "seats": 278595}} "403": application/json: {"error": "AlreadyCanceledSubscription", "detail": ""} "404": @@ -2351,6 +2367,8 @@ examples: application/json: {} "409": application/json: {"error": "SubscriptionLocked", "detail": ""} + "402": + application/json: {"error": "PaymentFailed", "detail": ""} subscriptions:revoke: speakeasy-default-subscriptions:revoke: parameters: @@ -2358,7 +2376,7 @@ examples: id: "" responses: "200": - application/json: {"created_at": "2023-04-13T16:53:14.377Z", "modified_at": "2023-10-09T16:03:24.107Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 93707, "status": "past_due", "current_period_start": "2024-09-21T11:35:55.569Z", "current_period_end": "2025-03-29T10:01:06.463Z", "trial_start": null, "trial_end": "2023-10-09T16:03:24.107Z", "cancel_at_period_end": true, "canceled_at": "2025-09-12T16:35:27.128Z", "started_at": "2025-07-19T10:57:44.516Z", "ends_at": "2023-01-14T16:02:07.001Z", "ended_at": "2024-04-09T01:58:52.778Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "customer_service", "customer_cancellation_comment": "", "metadata": {"key": "", "key1": false}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2025-02-06T08:24:11.064Z", "modified_at": null, "metadata": {}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2023-08-01T19:22:16.612Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2023-04-14T01:49:23.359Z", "modified_at": "2023-02-27T03:18:26.391Z", "trial_interval": "week", "trial_interval_count": 618257, "name": "", "description": "yowza meh ethyl where once exotic", "visibility": "draft", "recurring_interval": "month", "recurring_interval_count": 256997, "is_recurring": false, "is_archived": true, "organization_id": "", "metadata": {"key": 3063.89, "key1": true}, "prices": [{"created_at": "2023-10-09T16:03:24.107Z", "modified_at": "2023-10-18T20:01:51.483Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 574346, "legacy": true}, {"created_at": "2023-03-31T11:27:51.165Z", "modified_at": "2025-09-12T16:35:27.128Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}, {"created_at": "2025-09-25T04:14:25.732Z", "modified_at": "2025-11-14T15:31:42.442Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 606069, "legacy": true}], "benefits": [{"id": "", "created_at": "2023-10-30T15:15:07.973Z", "modified_at": "2025-02-25T11:02:14.286Z", "type": "meter_credit", "description": "circa cassava because", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 3478.81, "key1": "", "key2": true}, "properties": {"units": 921282, "rollover": false, "meter_id": ""}}, {"id": "", "created_at": "2023-10-30T15:15:07.973Z", "modified_at": "2025-02-25T11:02:14.286Z", "type": "meter_credit", "description": "circa cassava because", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 3478.81, "key1": "", "key2": true}, "properties": {"units": 921282, "rollover": false, "meter_id": ""}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 105567, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": null, "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-10-02T19:01:45.651Z", "size_readable": "", "public_url": "https://inconsequential-slide.com"}, {"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 105567, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": null, "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-10-02T19:01:45.651Z", "size_readable": "", "public_url": "https://inconsequential-slide.com"}, {"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 105567, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": null, "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-10-02T19:01:45.651Z", "size_readable": "", "public_url": "https://inconsequential-slide.com"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-04-12T03:15:38.858Z", "modified_at": "2025-07-13T21:55:11.751Z", "id": "", "metadata": {}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 712744, "required": false}]}, "discount": {"duration": "repeating", "duration_in_months": 153470, "type": "fixed", "basis_points": 284416, "created_at": "2024-03-23T02:00:57.683Z", "modified_at": "2025-01-27T19:18:40.809Z", "id": "", "metadata": {"key": 4126.15, "key1": 3937.48}, "name": "", "code": null, "starts_at": "2025-06-08T16:09:35.643Z", "ends_at": "2024-02-05T12:40:28.600Z", "max_redemptions": 819891, "redemptions_count": 779464, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [{"created_at": "2025-05-21T20:43:29.354Z", "modified_at": "2023-04-05T19:10:22.088Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2023-04-14T01:49:23.359Z", "modified_at": "2023-02-27T03:18:26.391Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 93707, "maximum_amount": 75257, "preset_amount": 135909, "legacy": true}, {"created_at": "2025-09-15T17:22:16.784Z", "modified_at": "2024-11-04T09:40:35.837Z", "id": "", "source": "catalog", "amount_type": "metered_unit", "price_currency": "", "is_archived": false, "product_id": "", "unit_amount": "", "cap_amount": 803091, "meter_id": "", "meter": {"id": "", "name": ""}}], "meters": [{"created_at": "2023-06-22T22:55:35.524Z", "modified_at": "2023-05-11T08:44:43.261Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": false, "key1": 561011}, "created_at": "2024-02-17T07:16:15.047Z", "modified_at": null, "id": "", "name": "", "filter": {"conjunction": "or", "clauses": [{"conjunction": "or", "clauses": []}]}, "aggregation": {"func": "max", "property": ""}, "organization_id": ""}}, {"created_at": "2023-06-22T22:55:35.524Z", "modified_at": "2023-05-11T08:44:43.261Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": false, "key1": 561011}, "created_at": "2024-02-17T07:16:15.047Z", "modified_at": null, "id": "", "name": "", "filter": {"conjunction": "or", "clauses": [{"conjunction": "or", "clauses": []}]}, "aggregation": {"func": "max", "property": ""}, "organization_id": ""}}, {"created_at": "2023-06-22T22:55:35.524Z", "modified_at": "2023-05-11T08:44:43.261Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": false, "key1": 561011}, "created_at": "2024-02-17T07:16:15.047Z", "modified_at": null, "id": "", "name": "", "filter": {"conjunction": "or", "clauses": [{"conjunction": "or", "clauses": []}]}, "aggregation": {"func": "max", "property": ""}, "organization_id": ""}}]} + application/json: {"created_at": "2023-04-13T16:53:14.377Z", "modified_at": "2023-10-09T16:03:24.107Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 93707, "status": "past_due", "current_period_start": "2024-09-21T11:35:55.569Z", "current_period_end": "2025-03-29T10:01:06.463Z", "trial_start": null, "trial_end": "2023-10-09T16:03:24.107Z", "cancel_at_period_end": true, "canceled_at": "2025-09-12T16:35:27.128Z", "started_at": "2025-07-19T10:57:44.516Z", "ends_at": "2023-01-14T16:02:07.001Z", "ended_at": "2024-04-09T01:58:52.778Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "customer_service", "customer_cancellation_comment": "", "metadata": {"key": "", "key1": false}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2025-02-06T08:24:11.064Z", "modified_at": null, "metadata": {}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2023-08-01T19:22:16.612Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2023-04-14T01:49:23.359Z", "modified_at": "2023-02-27T03:18:26.391Z", "trial_interval": "week", "trial_interval_count": 618257, "name": "", "description": "yowza meh ethyl where once exotic", "visibility": "draft", "recurring_interval": "month", "recurring_interval_count": 256997, "is_recurring": false, "is_archived": true, "organization_id": "", "metadata": {"key": 3063.89, "key1": true}, "prices": [{"created_at": "2023-10-09T16:03:24.107Z", "modified_at": "2023-10-18T20:01:51.483Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": null, "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 574346, "legacy": true}, {"created_at": "2023-03-31T11:27:51.165Z", "modified_at": "2025-09-12T16:35:27.128Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "tax_behavior": "location", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}, {"created_at": "2025-09-25T04:14:25.732Z", "modified_at": "2025-11-14T15:31:42.442Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 606069, "legacy": true}], "benefits": [{"id": "", "created_at": "2023-10-30T15:15:07.973Z", "modified_at": "2025-02-25T11:02:14.286Z", "type": "meter_credit", "description": "circa cassava because", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 3478.81, "key1": "", "key2": true}, "properties": {"units": 921282, "rollover": false, "meter_id": ""}}, {"id": "", "created_at": "2023-10-30T15:15:07.973Z", "modified_at": "2025-02-25T11:02:14.286Z", "type": "meter_credit", "description": "circa cassava because", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 3478.81, "key1": "", "key2": true}, "properties": {"units": 921282, "rollover": false, "meter_id": ""}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 105567, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": null, "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-10-02T19:01:45.651Z", "size_readable": "", "public_url": "https://inconsequential-slide.com"}, {"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 105567, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": null, "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-10-02T19:01:45.651Z", "size_readable": "", "public_url": "https://inconsequential-slide.com"}, {"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 105567, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": null, "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-10-02T19:01:45.651Z", "size_readable": "", "public_url": "https://inconsequential-slide.com"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-04-12T03:15:38.858Z", "modified_at": "2025-07-13T21:55:11.751Z", "id": "", "metadata": {}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 712744, "required": false}]}, "discount": {"duration": "repeating", "duration_in_months": 153470, "type": "fixed", "basis_points": 284416, "created_at": "2024-03-23T02:00:57.683Z", "modified_at": "2025-01-27T19:18:40.809Z", "id": "", "metadata": {"key": 4126.15, "key1": 3937.48}, "name": "", "code": null, "starts_at": "2025-06-08T16:09:35.643Z", "ends_at": "2024-02-05T12:40:28.600Z", "max_redemptions": 819891, "redemptions_count": 779464, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [{"created_at": "2025-05-21T20:43:29.354Z", "modified_at": "2023-04-05T19:10:22.088Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "tax_behavior": "inclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2023-04-14T01:49:23.359Z", "modified_at": "2023-02-27T03:18:26.391Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 93707, "maximum_amount": 75257, "preset_amount": 135909, "legacy": true}, {"created_at": "2025-09-15T17:22:16.784Z", "modified_at": "2024-11-04T09:40:35.837Z", "id": "", "source": "catalog", "amount_type": "metered_unit", "price_currency": "", "tax_behavior": "location", "is_archived": false, "product_id": "", "unit_amount": "", "cap_amount": 803091, "meter_id": "", "meter": {"id": "", "name": ""}}], "meters": [{"created_at": "2023-06-22T22:55:35.524Z", "modified_at": "2023-05-11T08:44:43.261Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": false, "key1": 561011}, "created_at": "2024-02-17T07:16:15.047Z", "modified_at": null, "id": "", "name": "", "filter": {"conjunction": "or", "clauses": [{"conjunction": "or", "clauses": []}]}, "aggregation": {"func": "max", "property": ""}, "organization_id": ""}}, {"created_at": "2023-06-22T22:55:35.524Z", "modified_at": "2023-05-11T08:44:43.261Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": false, "key1": 561011}, "created_at": "2024-02-17T07:16:15.047Z", "modified_at": null, "id": "", "name": "", "filter": {"conjunction": "or", "clauses": [{"conjunction": "or", "clauses": []}]}, "aggregation": {"func": "max", "property": ""}, "organization_id": ""}}, {"created_at": "2023-06-22T22:55:35.524Z", "modified_at": "2023-05-11T08:44:43.261Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {"key": false, "key1": 561011}, "created_at": "2024-02-17T07:16:15.047Z", "modified_at": null, "id": "", "name": "", "filter": {"conjunction": "or", "clauses": [{"conjunction": "or", "clauses": []}]}, "aggregation": {"func": "max", "property": ""}, "organization_id": ""}}], "pending_update": {"created_at": "2026-09-12T16:35:27.128Z", "modified_at": "2026-07-19T10:57:44.516Z", "id": "", "applies_at": "2024-09-14T11:29:54.406Z", "product_id": null, "seats": 423433}} "403": application/json: {"error": "AlreadyCanceledSubscription", "detail": ""} "404": @@ -2542,7 +2560,7 @@ examples: application/json: {"name": "", "prices": [], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "recurring_interval": "year"} responses: "201": - application/json: {"id": "", "created_at": "2025-01-12T01:51:18.973Z", "modified_at": "2025-11-10T04:18:09.355Z", "trial_interval": "month", "trial_interval_count": null, "name": "", "description": "well-worn against cash unless offensively chromakey exempt dense cruelly peony", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 746612, "is_recurring": true, "is_archived": false, "organization_id": "", "metadata": {"key": ""}, "prices": [{"created_at": "2023-04-20T14:04:54.240Z", "modified_at": "2024-11-07T17:01:01.790Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2024-03-29T16:30:59.890Z", "modified_at": "2025-08-23T16:40:00.782Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2023-11-12T20:54:36.929Z", "modified_at": null, "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 845799, "maximum_amount": 402294, "preset_amount": 275452, "legacy": true}], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/srv", "mime_type": "", "size": 791819, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-03-25T22:23:54.102Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2025-01-18T23:38:34.369Z", "size_readable": "", "public_url": "https://rewarding-defendant.org"}, {"id": "", "organization_id": "", "name": "", "path": "/srv", "mime_type": "", "size": 791819, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-03-25T22:23:54.102Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2025-01-18T23:38:34.369Z", "size_readable": "", "public_url": "https://rewarding-defendant.org"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-08-12T11:07:33.436Z", "modified_at": "2024-10-25T01:29:33.276Z", "id": "", "metadata": {}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 29798, "required": false}]} + application/json: {"id": "", "created_at": "2025-01-12T01:51:18.973Z", "modified_at": "2025-11-10T04:18:09.355Z", "trial_interval": "month", "trial_interval_count": null, "name": "", "description": "well-worn against cash unless offensively chromakey exempt dense cruelly peony", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 746612, "is_recurring": true, "is_archived": false, "organization_id": "", "metadata": {"key": ""}, "prices": [{"created_at": "2023-04-20T14:04:54.240Z", "modified_at": "2024-11-07T17:01:01.790Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2024-03-29T16:30:59.890Z", "modified_at": "2025-08-23T16:40:00.782Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "tax_behavior": null, "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2023-11-12T20:54:36.929Z", "modified_at": null, "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "inclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 845799, "maximum_amount": 402294, "preset_amount": 275452, "legacy": true}], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/srv", "mime_type": "", "size": 791819, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-03-25T22:23:54.102Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2025-01-18T23:38:34.369Z", "size_readable": "", "public_url": "https://rewarding-defendant.org"}, {"id": "", "organization_id": "", "name": "", "path": "/srv", "mime_type": "", "size": 791819, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-03-25T22:23:54.102Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2025-01-18T23:38:34.369Z", "size_readable": "", "public_url": "https://rewarding-defendant.org"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-08-12T11:07:33.436Z", "modified_at": "2024-10-25T01:29:33.276Z", "id": "", "metadata": {}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 29798, "required": false}]} "422": application/json: {} products:get: @@ -2552,7 +2570,7 @@ examples: id: "" responses: "200": - application/json: {"id": "", "created_at": "2024-02-13T06:53:33.624Z", "modified_at": "2023-05-12T13:18:24.858Z", "trial_interval": "month", "trial_interval_count": 612534, "name": "", "description": "unless spirit brr", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 624323, "is_recurring": true, "is_archived": false, "organization_id": "", "metadata": {"key": 6163.88, "key1": 9317.36}, "prices": [{"created_at": "2023-05-12T13:18:24.858Z", "modified_at": "2023-05-14T01:41:35.647Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 730788, "legacy": true}, {"created_at": "2023-11-27T09:27:19.424Z", "modified_at": "2025-05-27T01:17:58.930Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 949423, "legacy": true}, {"created_at": "2025-07-22T04:15:31.279Z", "modified_at": "2023-09-19T09:44:34.428Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}], "benefits": [{"id": "", "created_at": "2024-02-09T15:41:59.550Z", "modified_at": "2024-04-11T03:19:35.244Z", "type": "downloadables", "description": "simplistic loudly phony pomelo fiercely fellow hearten like politely geez", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 916.31, "key1": true, "key2": 42514}, "properties": {"archived": {"key": false, "key1": true}, "files": ["", ""]}}, {"id": "", "created_at": "2024-06-16T18:41:03.517Z", "modified_at": "2024-09-07T07:56:09.259Z", "type": "meter_credit", "description": "mmm neatly after", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 9567.58}, "properties": {"units": 361243, "rollover": false, "meter_id": ""}}], "medias": [], "attached_custom_fields": []} + application/json: {"id": "", "created_at": "2024-02-13T06:53:33.624Z", "modified_at": "2023-05-12T13:18:24.858Z", "trial_interval": "month", "trial_interval_count": 612534, "name": "", "description": "unless spirit brr", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 624323, "is_recurring": true, "is_archived": false, "organization_id": "", "metadata": {"key": 6163.88, "key1": 9317.36}, "prices": [{"created_at": "2023-05-12T13:18:24.858Z", "modified_at": "2023-05-14T01:41:35.647Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "inclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 730788, "legacy": true}, {"created_at": "2023-11-27T09:27:19.424Z", "modified_at": "2025-05-27T01:17:58.930Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "tax_behavior": "inclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 949423, "legacy": true}, {"created_at": "2025-07-22T04:15:31.279Z", "modified_at": "2023-09-19T09:44:34.428Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "tax_behavior": "location", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}], "benefits": [{"id": "", "created_at": "2024-02-09T15:41:59.550Z", "modified_at": "2024-04-11T03:19:35.244Z", "type": "downloadables", "description": "simplistic loudly phony pomelo fiercely fellow hearten like politely geez", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 916.31, "key1": true, "key2": 42514}, "properties": {"archived": {"key": false, "key1": true}, "files": ["", ""]}}, {"id": "", "created_at": "2024-06-16T18:41:03.517Z", "modified_at": "2024-09-07T07:56:09.259Z", "type": "meter_credit", "description": "mmm neatly after", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": 9567.58}, "properties": {"units": 361243, "rollover": false, "meter_id": ""}}], "medias": [], "attached_custom_fields": []} "404": application/json: {"error": "ResourceNotFound", "detail": ""} "422": @@ -2566,7 +2584,7 @@ examples: application/json: {} responses: "200": - application/json: {"id": "", "created_at": "2025-08-13T18:42:45.673Z", "modified_at": "2025-03-29T03:16:47.365Z", "trial_interval": "year", "trial_interval_count": 568567, "name": "", "description": "as hunger ouch since mash where yet", "visibility": "public", "recurring_interval": "year", "recurring_interval_count": 915832, "is_recurring": true, "is_archived": true, "organization_id": "", "metadata": {}, "prices": [{"created_at": "2025-03-29T03:16:47.365Z", "modified_at": "2024-11-10T13:10:18.334Z", "id": "", "source": "ad_hoc", "amount_type": "metered_unit", "price_currency": "", "is_archived": true, "product_id": "", "unit_amount": "", "cap_amount": 810331, "meter_id": "", "meter": {"id": "", "name": ""}}], "benefits": [{"id": "", "created_at": "2025-06-01T13:19:08.557Z", "modified_at": "2024-11-29T15:53:01.542Z", "type": "github_repository", "description": "rectangular extremely which proliferate offensively honestly", "selectable": true, "deletable": true, "organization_id": "", "metadata": {"key": true, "key1": ""}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "triage"}}, {"id": "", "created_at": "2025-08-28T21:34:45.570Z", "modified_at": "2025-07-10T04:28:46.581Z", "type": "downloadables", "description": "drat amongst consequently provision anenst sate while playfully catalyze moment", "selectable": true, "deletable": true, "organization_id": "", "metadata": {"key": 721783, "key1": 467378, "key2": true}, "properties": {"archived": {"key": false, "key1": true}, "files": []}}, {"id": "", "created_at": "2025-02-12T00:29:21.086Z", "modified_at": "2024-07-18T11:21:31.713Z", "type": "meter_credit", "description": "between meager for piglet etch yieldingly since fooey", "selectable": false, "deletable": false, "organization_id": "", "metadata": {"key": "", "key1": 100073}, "properties": {"units": 93199, "rollover": true, "meter_id": ""}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/etc/periodic", "mime_type": "", "size": 272557, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": "2023-09-15T04:26:05.951Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-06-09T10:26:56.093Z", "size_readable": "", "public_url": "https://fake-finer.com/"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-05-13T00:15:16.449Z", "modified_at": "2025-03-31T10:58:20.904Z", "id": "", "metadata": {"key": 214606, "key1": 570924}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 395589, "required": true}]} + application/json: {"id": "", "created_at": "2025-08-13T18:42:45.673Z", "modified_at": "2025-03-29T03:16:47.365Z", "trial_interval": "year", "trial_interval_count": 568567, "name": "", "description": "as hunger ouch since mash where yet", "visibility": "public", "recurring_interval": "year", "recurring_interval_count": 915832, "is_recurring": true, "is_archived": true, "organization_id": "", "metadata": {}, "prices": [{"created_at": "2025-03-29T03:16:47.365Z", "modified_at": "2024-11-10T13:10:18.334Z", "id": "", "source": "ad_hoc", "amount_type": "metered_unit", "price_currency": "", "tax_behavior": "exclusive", "is_archived": true, "product_id": "", "unit_amount": "", "cap_amount": 810331, "meter_id": "", "meter": {"id": "", "name": ""}}], "benefits": [{"id": "", "created_at": "2025-06-01T13:19:08.557Z", "modified_at": "2024-11-29T15:53:01.542Z", "type": "github_repository", "description": "rectangular extremely which proliferate offensively honestly", "selectable": true, "deletable": true, "organization_id": "", "metadata": {"key": true, "key1": ""}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "triage"}}, {"id": "", "created_at": "2025-08-28T21:34:45.570Z", "modified_at": "2025-07-10T04:28:46.581Z", "type": "downloadables", "description": "drat amongst consequently provision anenst sate while playfully catalyze moment", "selectable": true, "deletable": true, "organization_id": "", "metadata": {"key": 721783, "key1": 467378, "key2": true}, "properties": {"archived": {"key": false, "key1": true}, "files": []}}, {"id": "", "created_at": "2025-02-12T00:29:21.086Z", "modified_at": "2024-07-18T11:21:31.713Z", "type": "meter_credit", "description": "between meager for piglet etch yieldingly since fooey", "selectable": false, "deletable": false, "organization_id": "", "metadata": {"key": "", "key1": 100073}, "properties": {"units": 93199, "rollover": true, "meter_id": ""}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/etc/periodic", "mime_type": "", "size": 272557, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": "2023-09-15T04:26:05.951Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-06-09T10:26:56.093Z", "size_readable": "", "public_url": "https://fake-finer.com/"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-05-13T00:15:16.449Z", "modified_at": "2025-03-31T10:58:20.904Z", "id": "", "metadata": {"key": 214606, "key1": 570924}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 395589, "required": true}]} "403": application/json: {"error": "NotPermitted", "detail": ""} "404": @@ -2582,7 +2600,7 @@ examples: application/json: {"benefits": ["", "", ""]} responses: "200": - application/json: {"id": "", "created_at": "2023-09-28T22:38:03.685Z", "modified_at": "2024-01-11T22:10:13.497Z", "trial_interval": "day", "trial_interval_count": 342996, "name": "", "description": "blah bouncy until below spear dash border", "visibility": "public", "recurring_interval": "month", "recurring_interval_count": 247211, "is_recurring": true, "is_archived": false, "organization_id": "", "metadata": {"key": "", "key1": 244043}, "prices": [{"created_at": "2025-09-11T11:40:02.608Z", "modified_at": "2024-11-03T09:56:56.385Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 223202, "maximum_amount": 66059, "preset_amount": 500347, "legacy": true}], "benefits": [{"id": "", "created_at": "2024-09-18T09:49:18.801Z", "modified_at": "2023-06-23T04:47:46.915Z", "type": "github_repository", "description": "vastly meanwhile stage tennis coop", "selectable": false, "deletable": false, "organization_id": "", "metadata": {"key": ""}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "pull"}}, {"id": "", "created_at": "2025-10-26T03:43:57.806Z", "modified_at": "2024-04-17T17:44:58.962Z", "type": "meter_credit", "description": "daughter nor below ack till clone like against", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": true}, "properties": {"units": 113791, "rollover": true, "meter_id": ""}}, {"id": "", "created_at": "2023-06-30T04:50:32.342Z", "modified_at": "2023-01-27T19:24:13.189Z", "type": "license_keys", "description": "redraw whoa palate worldly hm impact lest dependable", "selectable": false, "deletable": true, "organization_id": "", "metadata": {}, "properties": {"prefix": "", "expires": {"ttl": 989033, "timeframe": "year"}, "activations": null, "limit_usage": 839068}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Users", "mime_type": "", "size": 770976, "storage_version": "", "checksum_etag": null, "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": "2023-11-20T01:46:26.319Z", "version": null, "service": "product_media", "is_uploaded": true, "created_at": "2025-09-22T06:25:51.641Z", "size_readable": "", "public_url": "https://well-groomed-creature.biz"}, {"id": "", "organization_id": "", "name": "", "path": "/Users", "mime_type": "", "size": 770976, "storage_version": "", "checksum_etag": null, "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": "2023-11-20T01:46:26.319Z", "version": null, "service": "product_media", "is_uploaded": true, "created_at": "2025-09-22T06:25:51.641Z", "size_readable": "", "public_url": "https://well-groomed-creature.biz"}, {"id": "", "organization_id": "", "name": "", "path": "/Users", "mime_type": "", "size": 770976, "storage_version": "", "checksum_etag": null, "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": "2023-11-20T01:46:26.319Z", "version": null, "service": "product_media", "is_uploaded": true, "created_at": "2025-09-22T06:25:51.641Z", "size_readable": "", "public_url": "https://well-groomed-creature.biz"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-08-17T06:02:23.238Z", "modified_at": "2025-03-20T20:03:53.850Z", "id": "", "metadata": {"key": 8435.67, "key1": 1752.52, "key2": false}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 516294, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2024-08-17T06:02:23.238Z", "modified_at": "2025-03-20T20:03:53.850Z", "id": "", "metadata": {"key": 8435.67, "key1": 1752.52, "key2": false}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 516294, "required": false}]} + application/json: {"id": "", "created_at": "2023-09-28T22:38:03.685Z", "modified_at": "2024-01-11T22:10:13.497Z", "trial_interval": "day", "trial_interval_count": 342996, "name": "", "description": "blah bouncy until below spear dash border", "visibility": "public", "recurring_interval": "month", "recurring_interval_count": 247211, "is_recurring": true, "is_archived": false, "organization_id": "", "metadata": {"key": "", "key1": 244043}, "prices": [{"created_at": "2025-09-11T11:40:02.608Z", "modified_at": "2024-11-03T09:56:56.385Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 223202, "maximum_amount": 66059, "preset_amount": 500347, "legacy": true}], "benefits": [{"id": "", "created_at": "2024-09-18T09:49:18.801Z", "modified_at": "2023-06-23T04:47:46.915Z", "type": "github_repository", "description": "vastly meanwhile stage tennis coop", "selectable": false, "deletable": false, "organization_id": "", "metadata": {"key": ""}, "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "pull"}}, {"id": "", "created_at": "2025-10-26T03:43:57.806Z", "modified_at": "2024-04-17T17:44:58.962Z", "type": "meter_credit", "description": "daughter nor below ack till clone like against", "selectable": true, "deletable": false, "organization_id": "", "metadata": {"key": true}, "properties": {"units": 113791, "rollover": true, "meter_id": ""}}, {"id": "", "created_at": "2023-06-30T04:50:32.342Z", "modified_at": "2023-01-27T19:24:13.189Z", "type": "license_keys", "description": "redraw whoa palate worldly hm impact lest dependable", "selectable": false, "deletable": true, "organization_id": "", "metadata": {}, "properties": {"prefix": "", "expires": {"ttl": 989033, "timeframe": "year"}, "activations": null, "limit_usage": 839068}}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Users", "mime_type": "", "size": 770976, "storage_version": "", "checksum_etag": null, "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": "2023-11-20T01:46:26.319Z", "version": null, "service": "product_media", "is_uploaded": true, "created_at": "2025-09-22T06:25:51.641Z", "size_readable": "", "public_url": "https://well-groomed-creature.biz"}, {"id": "", "organization_id": "", "name": "", "path": "/Users", "mime_type": "", "size": 770976, "storage_version": "", "checksum_etag": null, "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": "2023-11-20T01:46:26.319Z", "version": null, "service": "product_media", "is_uploaded": true, "created_at": "2025-09-22T06:25:51.641Z", "size_readable": "", "public_url": "https://well-groomed-creature.biz"}, {"id": "", "organization_id": "", "name": "", "path": "/Users", "mime_type": "", "size": 770976, "storage_version": "", "checksum_etag": null, "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": "2023-11-20T01:46:26.319Z", "version": null, "service": "product_media", "is_uploaded": true, "created_at": "2025-09-22T06:25:51.641Z", "size_readable": "", "public_url": "https://well-groomed-creature.biz"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-08-17T06:02:23.238Z", "modified_at": "2025-03-20T20:03:53.850Z", "id": "", "metadata": {"key": 8435.67, "key1": 1752.52, "key2": false}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 516294, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2024-08-17T06:02:23.238Z", "modified_at": "2025-03-20T20:03:53.850Z", "id": "", "metadata": {"key": 8435.67, "key1": 1752.52, "key2": false}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 516294, "required": false}]} "403": application/json: {"error": "NotPermitted", "detail": ""} "404": @@ -2661,7 +2679,7 @@ examples: limit: 10 responses: "200": - application/json: {"items": [{"id": "", "created_at": "2023-07-14T12:00:22.546Z", "modified_at": "2025-12-02T21:32:42.156Z", "payment_processor": "stripe", "status": "succeeded", "client_secret": "", "url": "https://punctual-guacamole.org", "expires_at": "2023-08-19T15:22:33.462Z", "success_url": "https://biodegradable-coal.com", "return_url": "https://definite-finer.org/", "embed_origin": "", "amount": 780504, "discount_amount": 766358, "net_amount": 630886, "tax_amount": 936353, "total_amount": 994328, "currency": "Algerian Dinar", "allow_trial": true, "active_trial_interval": "week", "active_trial_interval_count": 332812, "trial_end": "2024-12-26T22:49:45.749Z", "organization_id": "", "product_id": "", "product_price_id": "", "discount_id": "", "allow_discount_codes": false, "require_billing_address": false, "is_discount_applicable": true, "is_free_product_price": false, "is_payment_required": true, "is_payment_setup_required": true, "is_payment_form_required": true, "customer_id": "", "is_business_customer": true, "customer_name": "", "customer_email": "", "customer_ip_address": "", "customer_billing_name": "", "customer_billing_address": {"country": "US"}, "customer_tax_id": "", "payment_processor_metadata": {"key": ""}, "billing_address_fields": {"country": "required", "state": "optional", "city": "required", "postal_code": "required", "line1": "disabled", "line2": "optional"}, "trial_interval": "month", "trial_interval_count": 902613, "metadata": {"key": 507672, "key1": 563944}, "external_customer_id": "", "products": [{"id": "", "created_at": "2023-11-04T01:52:59.639Z", "modified_at": null, "trial_interval": "year", "trial_interval_count": null, "name": "", "description": "dally bungalow congregate howl", "visibility": "draft", "recurring_interval": "month", "recurring_interval_count": 345801, "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [], "benefits": [{"id": "", "created_at": "2025-12-18T03:04:16.879Z", "modified_at": "2025-12-13T18:59:55.618Z", "type": "custom", "description": "tennis badly hoick", "selectable": true, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/etc/periodic", "mime_type": "", "size": 790983, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-01-28T15:09:33.411Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-03-27T20:48:20.123Z", "size_readable": "", "public_url": "https://skeletal-solvency.com"}, {"id": "", "organization_id": "", "name": "", "path": "/etc/periodic", "mime_type": "", "size": 790983, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-01-28T15:09:33.411Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-03-27T20:48:20.123Z", "size_readable": "", "public_url": "https://skeletal-solvency.com"}, {"id": "", "organization_id": "", "name": "", "path": "/etc/periodic", "mime_type": "", "size": 790983, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-01-28T15:09:33.411Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-03-27T20:48:20.123Z", "size_readable": "", "public_url": "https://skeletal-solvency.com"}]}, {"id": "", "created_at": "2023-11-04T01:52:59.639Z", "modified_at": null, "trial_interval": "day", "trial_interval_count": 780504, "name": "", "description": "dally bungalow congregate howl", "visibility": "private", "recurring_interval": "month", "recurring_interval_count": 332812, "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [], "benefits": [{"id": "", "created_at": "2025-12-18T03:04:16.879Z", "modified_at": "2025-12-13T18:59:55.618Z", "type": "custom", "description": "tennis badly hoick", "selectable": true, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/etc/periodic", "mime_type": "", "size": 790983, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-01-28T15:09:33.411Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-03-27T20:48:20.123Z", "size_readable": "", "public_url": "https://skeletal-solvency.com"}, {"id": "", "organization_id": "", "name": "", "path": "/etc/periodic", "mime_type": "", "size": 790983, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-01-28T15:09:33.411Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-03-27T20:48:20.123Z", "size_readable": "", "public_url": "https://skeletal-solvency.com"}, {"id": "", "organization_id": "", "name": "", "path": "/etc/periodic", "mime_type": "", "size": 790983, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-01-28T15:09:33.411Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-03-27T20:48:20.123Z", "size_readable": "", "public_url": "https://skeletal-solvency.com"}]}], "product": {"id": "", "created_at": "2025-10-08T08:06:47.691Z", "modified_at": "2023-01-13T21:51:28.028Z", "trial_interval": "month", "trial_interval_count": 936353, "name": "", "description": "wildly edge except so calculus square", "visibility": "draft", "recurring_interval": "year", "recurring_interval_count": 662364, "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2023-07-14T12:00:22.546Z", "modified_at": "2025-12-02T21:32:42.156Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 645390, "legacy": true}, {"created_at": "2023-08-19T15:22:33.462Z", "modified_at": "2023-03-15T09:19:49.081Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}, {"created_at": "2025-04-19T22:15:44.328Z", "modified_at": "2024-07-26T10:32:13.861Z", "id": "", "source": "ad_hoc", "amount_type": "metered_unit", "price_currency": "", "is_archived": false, "product_id": "", "unit_amount": "", "cap_amount": 762494, "meter_id": "", "meter": {"id": "", "name": ""}}], "benefits": [{"id": "", "created_at": "2025-12-18T03:04:16.879Z", "modified_at": "2025-12-13T18:59:55.618Z", "type": "custom", "description": "tennis badly hoick", "selectable": true, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-12-18T03:04:16.879Z", "modified_at": "2025-12-13T18:59:55.618Z", "type": "custom", "description": "tennis badly hoick", "selectable": true, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/etc/periodic", "mime_type": "", "size": 790983, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-01-28T15:09:33.411Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-03-27T20:48:20.123Z", "size_readable": "", "public_url": "https://skeletal-solvency.com"}]}, "product_price": {"created_at": "2026-12-02T21:32:42.156Z", "modified_at": "2025-09-19T19:41:27.901Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 210438, "maximum_amount": 66960, "preset_amount": 136812, "legacy": true}, "prices": {"key": [], "key1": [{"created_at": "2023-03-15T09:19:49.081Z", "modified_at": "2023-05-30T22:42:00.703Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}]}, "discount": null, "subscription_id": "", "attached_custom_fields": [], "customer_metadata": {"key": 163571, "key1": 954376}}], "pagination": {"total_count": 608889, "max_page": 572838}} + application/json: {"items": [{"id": "", "created_at": "2023-07-14T12:00:22.546Z", "modified_at": "2025-12-02T21:32:42.156Z", "payment_processor": "stripe", "status": "succeeded", "client_secret": "", "url": "https://punctual-guacamole.org", "expires_at": "2023-08-19T15:22:33.462Z", "success_url": "https://biodegradable-coal.com", "return_url": "https://definite-finer.org/", "embed_origin": "", "amount": 780504, "discount_amount": 766358, "net_amount": 630886, "tax_amount": 936353, "total_amount": 994328, "currency": "Algerian Dinar", "allow_trial": true, "active_trial_interval": "week", "active_trial_interval_count": 332812, "trial_end": "2024-12-26T22:49:45.749Z", "organization_id": "", "product_id": "", "product_price_id": "", "discount_id": "", "allow_discount_codes": false, "require_billing_address": false, "is_discount_applicable": true, "is_free_product_price": false, "is_payment_required": true, "is_payment_setup_required": true, "is_payment_form_required": true, "customer_id": "", "is_business_customer": true, "customer_name": "", "customer_email": "", "customer_ip_address": "", "customer_billing_name": "", "customer_billing_address": {"country": "US"}, "customer_tax_id": "", "payment_processor_metadata": {"key": ""}, "billing_address_fields": {"country": "required", "state": "optional", "city": "required", "postal_code": "required", "line1": "disabled", "line2": "optional"}, "trial_interval": "month", "trial_interval_count": 902613, "metadata": {"key": 507672, "key1": 563944}, "external_customer_id": "", "products": [{"id": "", "created_at": "2023-11-04T01:52:59.639Z", "modified_at": null, "trial_interval": "year", "trial_interval_count": null, "name": "", "description": "dally bungalow congregate howl", "visibility": "draft", "recurring_interval": "month", "recurring_interval_count": 345801, "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [], "benefits": [{"id": "", "created_at": "2025-12-18T03:04:16.879Z", "modified_at": "2025-12-13T18:59:55.618Z", "type": "custom", "description": "tennis badly hoick", "selectable": true, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/etc/periodic", "mime_type": "", "size": 790983, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-01-28T15:09:33.411Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-03-27T20:48:20.123Z", "size_readable": "", "public_url": "https://skeletal-solvency.com"}, {"id": "", "organization_id": "", "name": "", "path": "/etc/periodic", "mime_type": "", "size": 790983, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-01-28T15:09:33.411Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-03-27T20:48:20.123Z", "size_readable": "", "public_url": "https://skeletal-solvency.com"}, {"id": "", "organization_id": "", "name": "", "path": "/etc/periodic", "mime_type": "", "size": 790983, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-01-28T15:09:33.411Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-03-27T20:48:20.123Z", "size_readable": "", "public_url": "https://skeletal-solvency.com"}]}, {"id": "", "created_at": "2023-11-04T01:52:59.639Z", "modified_at": null, "trial_interval": "day", "trial_interval_count": 780504, "name": "", "description": "dally bungalow congregate howl", "visibility": "private", "recurring_interval": "month", "recurring_interval_count": 332812, "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [], "benefits": [{"id": "", "created_at": "2025-12-18T03:04:16.879Z", "modified_at": "2025-12-13T18:59:55.618Z", "type": "custom", "description": "tennis badly hoick", "selectable": true, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/etc/periodic", "mime_type": "", "size": 790983, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-01-28T15:09:33.411Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-03-27T20:48:20.123Z", "size_readable": "", "public_url": "https://skeletal-solvency.com"}, {"id": "", "organization_id": "", "name": "", "path": "/etc/periodic", "mime_type": "", "size": 790983, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-01-28T15:09:33.411Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-03-27T20:48:20.123Z", "size_readable": "", "public_url": "https://skeletal-solvency.com"}, {"id": "", "organization_id": "", "name": "", "path": "/etc/periodic", "mime_type": "", "size": 790983, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-01-28T15:09:33.411Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-03-27T20:48:20.123Z", "size_readable": "", "public_url": "https://skeletal-solvency.com"}]}], "product": {"id": "", "created_at": "2025-10-08T08:06:47.691Z", "modified_at": "2023-01-13T21:51:28.028Z", "trial_interval": "month", "trial_interval_count": 936353, "name": "", "description": "wildly edge except so calculus square", "visibility": "draft", "recurring_interval": "year", "recurring_interval_count": 662364, "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2023-07-14T12:00:22.546Z", "modified_at": "2025-12-02T21:32:42.156Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 645390, "legacy": true}, {"created_at": "2023-08-19T15:22:33.462Z", "modified_at": "2023-03-15T09:19:49.081Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}, {"created_at": "2025-04-19T22:15:44.328Z", "modified_at": "2024-07-26T10:32:13.861Z", "id": "", "source": "ad_hoc", "amount_type": "metered_unit", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "unit_amount": "", "cap_amount": 762494, "meter_id": "", "meter": {"id": "", "name": ""}}], "benefits": [{"id": "", "created_at": "2025-12-18T03:04:16.879Z", "modified_at": "2025-12-13T18:59:55.618Z", "type": "custom", "description": "tennis badly hoick", "selectable": true, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-12-18T03:04:16.879Z", "modified_at": "2025-12-13T18:59:55.618Z", "type": "custom", "description": "tennis badly hoick", "selectable": true, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/etc/periodic", "mime_type": "", "size": 790983, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-01-28T15:09:33.411Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2023-03-27T20:48:20.123Z", "size_readable": "", "public_url": "https://skeletal-solvency.com"}]}, "product_price": {"created_at": "2026-12-02T21:32:42.156Z", "modified_at": "2025-09-19T19:41:27.901Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "inclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 210438, "maximum_amount": 66960, "preset_amount": 136812, "legacy": true}, "prices": {"key": [], "key1": [{"created_at": "2023-03-15T09:19:49.081Z", "modified_at": "2023-05-30T22:42:00.703Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}]}, "discount": null, "subscription_id": "", "attached_custom_fields": [], "customer_metadata": {"key": 163571, "key1": 954376}}], "pagination": {"total_count": 608889, "max_page": 572838}} "422": application/json: {} checkouts:create: @@ -2670,7 +2688,7 @@ examples: application/json: {"allow_discount_codes": true, "require_billing_address": false, "allow_trial": true, "is_business_customer": false, "customer_name": "John Doe", "customer_billing_address": {"country": "US"}, "locale": "en", "products": ["", "", ""]} responses: "201": - application/json: {"id": "", "created_at": "2024-01-03T23:26:44.843Z", "modified_at": "2023-01-06T02:40:29.447Z", "payment_processor": "stripe", "status": "failed", "client_secret": "", "url": "https://willing-outset.info/", "expires_at": "2025-05-04T00:57:38.223Z", "success_url": "https://wonderful-adrenalin.info", "return_url": "https://great-fen.com", "embed_origin": "", "amount": 267381, "discount_amount": 51493, "net_amount": 549002, "tax_amount": 457933, "total_amount": 901758, "currency": "Singapore Dollar", "allow_trial": false, "active_trial_interval": "year", "active_trial_interval_count": 324391, "trial_end": null, "organization_id": "", "product_id": "", "product_price_id": "", "discount_id": "", "allow_discount_codes": false, "require_billing_address": true, "is_discount_applicable": true, "is_free_product_price": true, "is_payment_required": false, "is_payment_setup_required": false, "is_payment_form_required": true, "customer_id": "", "is_business_customer": true, "customer_name": "", "customer_email": "", "customer_ip_address": "", "customer_billing_name": "", "customer_billing_address": {"country": "US"}, "customer_tax_id": "", "payment_processor_metadata": {"key": "", "key1": "", "key2": ""}, "billing_address_fields": {"country": "disabled", "state": "disabled", "city": "optional", "postal_code": "required", "line1": "required", "line2": "disabled"}, "trial_interval": "week", "trial_interval_count": 632047, "metadata": {"key": true, "key1": 633599}, "external_customer_id": "", "products": [{"id": "", "created_at": "2024-02-11T14:47:29.817Z", "modified_at": "2023-12-03T20:20:32.728Z", "trial_interval": "year", "trial_interval_count": 978623, "name": "", "description": "mousse psst pulp because connect deer coordination drum behind yieldingly", "visibility": "public", "recurring_interval": "month", "recurring_interval_count": 974785, "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2024-01-03T23:26:44.843Z", "modified_at": "2023-01-06T02:40:29.447Z", "id": "", "source": "catalog", "amount_type": "metered_unit", "price_currency": "", "is_archived": false, "product_id": "", "unit_amount": "", "cap_amount": 779234, "meter_id": "", "meter": {"id": "", "name": ""}}], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/var/tmp", "mime_type": "", "size": 957931, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-05-06T15:29:56.878Z", "version": null, "service": "product_media", "is_uploaded": true, "created_at": "2024-04-02T19:44:45.852Z", "size_readable": "", "public_url": "https://nervous-jet.com/"}]}], "product": {"id": "", "created_at": "2025-06-14T10:40:20.746Z", "modified_at": "2025-01-27T16:41:51.128Z", "trial_interval": null, "trial_interval_count": 452269, "name": "", "description": "over competent powerfully", "visibility": "public", "recurring_interval": "year", "recurring_interval_count": 324391, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2023-01-14T08:53:43.010Z", "modified_at": "2024-05-10T16:28:30.439Z", "id": "", "source": "catalog", "amount_type": "metered_unit", "price_currency": "", "is_archived": true, "product_id": "", "unit_amount": "", "cap_amount": 901758, "meter_id": "", "meter": {"id": "", "name": ""}}], "benefits": [], "medias": []}, "product_price": {"created_at": "2024-01-06T02:40:29.447Z", "modified_at": "2025-05-30T19:19:24.495Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "week", "minimum_amount": 779234, "maximum_amount": 978623, "preset_amount": null, "legacy": true}, "prices": {"key": [{"created_at": "2025-05-04T00:57:38.223Z", "modified_at": "2025-12-08T13:41:13.215Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "day", "legacy": true}]}, "discount": {"duration": "forever", "duration_in_months": 602692, "type": "percentage", "basis_points": 1000, "id": "", "name": "", "code": null}, "subscription_id": "", "attached_custom_fields": [], "customer_metadata": {"key": true, "key1": 753950, "key2": ""}} + application/json: {"id": "", "created_at": "2024-01-03T23:26:44.843Z", "modified_at": "2023-01-06T02:40:29.447Z", "payment_processor": "stripe", "status": "failed", "client_secret": "", "url": "https://willing-outset.info/", "expires_at": "2025-05-04T00:57:38.223Z", "success_url": "https://wonderful-adrenalin.info", "return_url": "https://great-fen.com", "embed_origin": "", "amount": 267381, "discount_amount": 51493, "net_amount": 549002, "tax_amount": 457933, "total_amount": 901758, "currency": "Singapore Dollar", "allow_trial": false, "active_trial_interval": "year", "active_trial_interval_count": 324391, "trial_end": null, "organization_id": "", "product_id": "", "product_price_id": "", "discount_id": "", "allow_discount_codes": false, "require_billing_address": true, "is_discount_applicable": true, "is_free_product_price": true, "is_payment_required": false, "is_payment_setup_required": false, "is_payment_form_required": true, "customer_id": "", "is_business_customer": true, "customer_name": "", "customer_email": "", "customer_ip_address": "", "customer_billing_name": "", "customer_billing_address": {"country": "US"}, "customer_tax_id": "", "payment_processor_metadata": {"key": "", "key1": "", "key2": ""}, "billing_address_fields": {"country": "disabled", "state": "disabled", "city": "optional", "postal_code": "required", "line1": "required", "line2": "disabled"}, "trial_interval": "week", "trial_interval_count": 632047, "metadata": {"key": true, "key1": 633599}, "external_customer_id": "", "products": [{"id": "", "created_at": "2024-02-11T14:47:29.817Z", "modified_at": "2023-12-03T20:20:32.728Z", "trial_interval": "year", "trial_interval_count": 978623, "name": "", "description": "mousse psst pulp because connect deer coordination drum behind yieldingly", "visibility": "public", "recurring_interval": "month", "recurring_interval_count": 974785, "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2024-01-03T23:26:44.843Z", "modified_at": "2023-01-06T02:40:29.447Z", "id": "", "source": "catalog", "amount_type": "metered_unit", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "unit_amount": "", "cap_amount": 779234, "meter_id": "", "meter": {"id": "", "name": ""}}], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/var/tmp", "mime_type": "", "size": 957931, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-05-06T15:29:56.878Z", "version": null, "service": "product_media", "is_uploaded": true, "created_at": "2024-04-02T19:44:45.852Z", "size_readable": "", "public_url": "https://nervous-jet.com/"}]}], "product": {"id": "", "created_at": "2025-06-14T10:40:20.746Z", "modified_at": "2025-01-27T16:41:51.128Z", "trial_interval": null, "trial_interval_count": 452269, "name": "", "description": "over competent powerfully", "visibility": "public", "recurring_interval": "year", "recurring_interval_count": 324391, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2023-01-14T08:53:43.010Z", "modified_at": "2024-05-10T16:28:30.439Z", "id": "", "source": "catalog", "amount_type": "metered_unit", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "unit_amount": "", "cap_amount": 901758, "meter_id": "", "meter": {"id": "", "name": ""}}], "benefits": [], "medias": []}, "product_price": {"created_at": "2024-01-06T02:40:29.447Z", "modified_at": "2025-05-30T19:19:24.495Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": null, "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "week", "minimum_amount": 779234, "maximum_amount": 978623, "preset_amount": null, "legacy": true}, "prices": {"key": [{"created_at": "2025-05-04T00:57:38.223Z", "modified_at": "2025-12-08T13:41:13.215Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "tax_behavior": "inclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "day", "legacy": true}]}, "discount": {"duration": "forever", "duration_in_months": 602692, "type": "percentage", "basis_points": 1000, "id": "", "name": "", "code": null}, "subscription_id": "", "attached_custom_fields": [], "customer_metadata": {"key": true, "key1": 753950, "key2": ""}} "422": application/json: {} checkouts:get: @@ -2680,7 +2698,7 @@ examples: id: "" responses: "200": - application/json: {"id": "", "created_at": "2024-08-11T03:11:01.239Z", "modified_at": "2025-11-29T01:58:06.554Z", "payment_processor": "stripe", "status": "succeeded", "client_secret": "", "url": "https://dirty-maestro.info", "expires_at": "2023-10-11T06:44:37.699Z", "success_url": "https://low-hope.name", "return_url": "https://willing-ribbon.net/", "embed_origin": "", "amount": 604568, "discount_amount": 435126, "net_amount": 202456, "tax_amount": 729244, "total_amount": 885841, "currency": "Tugrik", "allow_trial": true, "active_trial_interval": "day", "active_trial_interval_count": 759954, "trial_end": "2023-08-04T19:41:02.160Z", "organization_id": "", "product_id": "", "product_price_id": "", "discount_id": "", "allow_discount_codes": false, "require_billing_address": true, "is_discount_applicable": false, "is_free_product_price": true, "is_payment_required": false, "is_payment_setup_required": true, "is_payment_form_required": true, "customer_id": "", "is_business_customer": true, "customer_name": "", "customer_email": "", "customer_ip_address": "", "customer_billing_name": "", "customer_billing_address": {"country": "US"}, "customer_tax_id": "", "payment_processor_metadata": {"key": "", "key1": ""}, "billing_address_fields": {"country": "optional", "state": "required", "city": "disabled", "postal_code": "disabled", "line1": "disabled", "line2": "required"}, "trial_interval": "week", "trial_interval_count": 626845, "metadata": {"key": "", "key1": 1174.35}, "external_customer_id": "", "products": [{"id": "", "created_at": "2023-08-31T20:57:39.863Z", "modified_at": "2023-04-27T14:53:08.193Z", "trial_interval": "week", "trial_interval_count": 565134, "name": "", "description": "inveigle fooey frankly", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 172766, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [], "benefits": [{"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}, {"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}, {"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}]}, {"id": "", "created_at": "2023-08-31T20:57:39.863Z", "modified_at": "2023-04-27T14:53:08.193Z", "trial_interval": "week", "trial_interval_count": 178822, "name": "", "description": "inveigle fooey frankly", "visibility": "draft", "recurring_interval": "year", "recurring_interval_count": 759954, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [], "benefits": [{"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}, {"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}, {"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}]}, {"id": "", "created_at": "2023-08-31T20:57:39.863Z", "modified_at": "2023-04-27T14:53:08.193Z", "trial_interval": "year", "trial_interval_count": 221002, "name": "", "description": "inveigle fooey frankly", "visibility": "public", "recurring_interval": "year", "recurring_interval_count": 196916, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [], "benefits": [{"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}, {"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}, {"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}]}], "product": {"id": "", "created_at": "2024-04-29T21:31:34.931Z", "modified_at": null, "trial_interval": "week", "trial_interval_count": 16708, "name": "", "description": "silk plus an cavernous vamoose", "visibility": "public", "recurring_interval": "month", "recurring_interval_count": 387522, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2025-11-29T01:58:06.554Z", "modified_at": "2025-02-24T18:28:07.898Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 486695, "maximum_amount": 601699, "preset_amount": 604568, "legacy": true}, {"created_at": "2023-07-15T23:44:52.247Z", "modified_at": "2025-08-28T21:08:23.306Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 472045, "maximum_amount": 16708, "preset_amount": 342156, "legacy": true}], "benefits": [{"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}, {"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}]}, "product_price": {"created_at": "2026-02-24T18:28:07.898Z", "modified_at": "2025-08-14T06:11:53.782Z", "id": "", "source": "catalog", "amount_type": "metered_unit", "price_currency": "", "is_archived": true, "product_id": "", "unit_amount": "", "cap_amount": 486695, "meter_id": "", "meter": {"id": "", "name": ""}}, "prices": {"key": [], "key1": []}, "discount": {"duration": "repeating", "type": "percentage", "basis_points": 1000, "id": "", "name": "", "code": ""}, "subscription_id": "", "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-09-07T23:03:34.581Z", "modified_at": "2025-12-24T16:06:04.760Z", "id": "", "metadata": {"key": ""}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 200397, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2023-09-07T23:03:34.581Z", "modified_at": "2025-12-24T16:06:04.760Z", "id": "", "metadata": {"key": ""}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 200397, "required": true}], "customer_metadata": {"key": 154385}} + application/json: {"id": "", "created_at": "2024-08-11T03:11:01.239Z", "modified_at": "2025-11-29T01:58:06.554Z", "payment_processor": "stripe", "status": "succeeded", "client_secret": "", "url": "https://dirty-maestro.info", "expires_at": "2023-10-11T06:44:37.699Z", "success_url": "https://low-hope.name", "return_url": "https://willing-ribbon.net/", "embed_origin": "", "amount": 604568, "discount_amount": 435126, "net_amount": 202456, "tax_amount": 729244, "total_amount": 885841, "currency": "Tugrik", "allow_trial": true, "active_trial_interval": "day", "active_trial_interval_count": 759954, "trial_end": "2023-08-04T19:41:02.160Z", "organization_id": "", "product_id": "", "product_price_id": "", "discount_id": "", "allow_discount_codes": false, "require_billing_address": true, "is_discount_applicable": false, "is_free_product_price": true, "is_payment_required": false, "is_payment_setup_required": true, "is_payment_form_required": true, "customer_id": "", "is_business_customer": true, "customer_name": "", "customer_email": "", "customer_ip_address": "", "customer_billing_name": "", "customer_billing_address": {"country": "US"}, "customer_tax_id": "", "payment_processor_metadata": {"key": "", "key1": ""}, "billing_address_fields": {"country": "optional", "state": "required", "city": "disabled", "postal_code": "disabled", "line1": "disabled", "line2": "required"}, "trial_interval": "week", "trial_interval_count": 626845, "metadata": {"key": "", "key1": 1174.35}, "external_customer_id": "", "products": [{"id": "", "created_at": "2023-08-31T20:57:39.863Z", "modified_at": "2023-04-27T14:53:08.193Z", "trial_interval": "week", "trial_interval_count": 565134, "name": "", "description": "inveigle fooey frankly", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 172766, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [], "benefits": [{"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}, {"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}, {"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}]}, {"id": "", "created_at": "2023-08-31T20:57:39.863Z", "modified_at": "2023-04-27T14:53:08.193Z", "trial_interval": "week", "trial_interval_count": 178822, "name": "", "description": "inveigle fooey frankly", "visibility": "draft", "recurring_interval": "year", "recurring_interval_count": 759954, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [], "benefits": [{"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}, {"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}, {"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}]}, {"id": "", "created_at": "2023-08-31T20:57:39.863Z", "modified_at": "2023-04-27T14:53:08.193Z", "trial_interval": "year", "trial_interval_count": 221002, "name": "", "description": "inveigle fooey frankly", "visibility": "public", "recurring_interval": "year", "recurring_interval_count": 196916, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [], "benefits": [{"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}, {"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}, {"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}]}], "product": {"id": "", "created_at": "2024-04-29T21:31:34.931Z", "modified_at": null, "trial_interval": "week", "trial_interval_count": 16708, "name": "", "description": "silk plus an cavernous vamoose", "visibility": "public", "recurring_interval": "month", "recurring_interval_count": 387522, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2025-11-29T01:58:06.554Z", "modified_at": "2025-02-24T18:28:07.898Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 486695, "maximum_amount": 601699, "preset_amount": 604568, "legacy": true}, {"created_at": "2023-07-15T23:44:52.247Z", "modified_at": "2025-08-28T21:08:23.306Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 472045, "maximum_amount": 16708, "preset_amount": 342156, "legacy": true}], "benefits": [{"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-11-01T21:53:06.694Z", "modified_at": "2023-01-04T18:26:29.729Z", "type": "meter_credit", "description": "gosh ashamed viciously swat", "selectable": true, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}, {"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 8837, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-11-12T05:04:28.264Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-01-31T09:04:35.400Z", "size_readable": "", "public_url": "https://woeful-alb.com"}]}, "product_price": {"created_at": "2026-02-24T18:28:07.898Z", "modified_at": "2025-08-14T06:11:53.782Z", "id": "", "source": "catalog", "amount_type": "metered_unit", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "unit_amount": "", "cap_amount": 486695, "meter_id": "", "meter": {"id": "", "name": ""}}, "prices": {"key": [], "key1": []}, "discount": {"duration": "repeating", "type": "percentage", "basis_points": 1000, "id": "", "name": "", "code": ""}, "subscription_id": "", "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-09-07T23:03:34.581Z", "modified_at": "2025-12-24T16:06:04.760Z", "id": "", "metadata": {"key": ""}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 200397, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2023-09-07T23:03:34.581Z", "modified_at": "2025-12-24T16:06:04.760Z", "id": "", "metadata": {"key": ""}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 200397, "required": true}], "customer_metadata": {"key": 154385}} "404": application/json: {"error": "ResourceNotFound", "detail": ""} "422": @@ -2694,7 +2712,7 @@ examples: application/json: {"customer_name": "John Doe", "customer_billing_address": {"country": "US"}, "locale": "en"} responses: "200": - application/json: {"id": "", "created_at": "2025-08-11T13:37:19.351Z", "modified_at": "2025-01-17T16:36:47.350Z", "payment_processor": "stripe", "status": "expired", "client_secret": "", "url": "https://quiet-longboat.name/", "expires_at": "2024-06-26T17:48:32.882Z", "success_url": "https://flawless-conversation.com/", "return_url": "https://winding-pliers.biz", "embed_origin": "", "amount": 854455, "discount_amount": 294901, "net_amount": 889166, "tax_amount": 922052, "total_amount": 719988, "currency": "Rufiyaa", "allow_trial": false, "active_trial_interval": "year", "active_trial_interval_count": 682201, "trial_end": "2023-04-12T18:01:42.534Z", "organization_id": "", "product_id": "", "product_price_id": "", "discount_id": null, "allow_discount_codes": false, "require_billing_address": true, "is_discount_applicable": false, "is_free_product_price": true, "is_payment_required": true, "is_payment_setup_required": false, "is_payment_form_required": false, "customer_id": "", "is_business_customer": true, "customer_name": null, "customer_email": "", "customer_ip_address": "", "customer_billing_name": "", "customer_billing_address": {"country": "US"}, "customer_tax_id": "", "payment_processor_metadata": {"key": "", "key1": "", "key2": ""}, "billing_address_fields": {"country": "required", "state": "disabled", "city": "disabled", "postal_code": "disabled", "line1": "required", "line2": "required"}, "trial_interval": "month", "trial_interval_count": 495203, "metadata": {"key": 175107, "key1": "", "key2": 598875}, "external_customer_id": "", "products": [{"id": "", "created_at": "2024-10-08T05:33:56.764Z", "modified_at": "2023-07-14T21:58:46.090Z", "trial_interval": null, "trial_interval_count": 186577, "name": "", "description": "where underneath ignorant smoke pearl interesting meh amid", "visibility": "draft", "recurring_interval": null, "recurring_interval_count": 870044, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2025-11-30T19:59:27.996Z", "modified_at": "2023-09-30T23:37:22.091Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2024-06-26T17:48:32.882Z", "modified_at": null, "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}], "benefits": [{"id": "", "created_at": "2024-08-22T08:39:31.775Z", "modified_at": "2024-02-01T17:03:37.242Z", "type": "discord", "description": "overconfidently overplay down unless dilate before optimistically while curly by", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 72601, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-08-08T03:26:06.485Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-12T01:25:31.801Z", "size_readable": "", "public_url": "https://inexperienced-valuable.name/"}, {"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 72601, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-08-08T03:26:06.485Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-12T01:25:31.801Z", "size_readable": "", "public_url": "https://inexperienced-valuable.name/"}, {"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 72601, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-08-08T03:26:06.485Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-12T01:25:31.801Z", "size_readable": "", "public_url": "https://inexperienced-valuable.name/"}]}, {"id": "", "created_at": "2024-10-08T05:33:56.764Z", "modified_at": "2023-07-14T21:58:46.090Z", "trial_interval": "day", "trial_interval_count": 294901, "name": "", "description": "where underneath ignorant smoke pearl interesting meh amid", "visibility": "public", "recurring_interval": null, "recurring_interval_count": 682201, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2025-09-01T12:37:02.777Z", "modified_at": "2025-10-07T13:38:06.522Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 615287, "legacy": true}, {"created_at": "2024-02-21T06:51:40.935Z", "modified_at": null, "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 391538, "legacy": true}], "benefits": [{"id": "", "created_at": "2024-08-22T08:39:31.775Z", "modified_at": "2024-02-01T17:03:37.242Z", "type": "discord", "description": "overconfidently overplay down unless dilate before optimistically while curly by", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 72601, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-08-08T03:26:06.485Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-12T01:25:31.801Z", "size_readable": "", "public_url": "https://inexperienced-valuable.name/"}, {"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 72601, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-08-08T03:26:06.485Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-12T01:25:31.801Z", "size_readable": "", "public_url": "https://inexperienced-valuable.name/"}, {"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 72601, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-08-08T03:26:06.485Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-12T01:25:31.801Z", "size_readable": "", "public_url": "https://inexperienced-valuable.name/"}]}], "product": {"id": "", "created_at": "2023-09-02T08:09:15.374Z", "modified_at": "2023-01-08T13:18:17.680Z", "trial_interval": "year", "trial_interval_count": 719988, "name": "", "description": null, "visibility": "public", "recurring_interval": "year", "recurring_interval_count": 92838, "is_recurring": false, "is_archived": true, "organization_id": "", "prices": [], "benefits": [{"id": "", "created_at": "2024-08-22T08:39:31.775Z", "modified_at": "2024-02-01T17:03:37.242Z", "type": "discord", "description": "overconfidently overplay down unless dilate before optimistically while curly by", "selectable": false, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2024-08-22T08:39:31.775Z", "modified_at": "2024-02-01T17:03:37.242Z", "type": "discord", "description": "overconfidently overplay down unless dilate before optimistically while curly by", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 72601, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-08-08T03:26:06.485Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-12T01:25:31.801Z", "size_readable": "", "public_url": "https://inexperienced-valuable.name/"}, {"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 72601, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-08-08T03:26:06.485Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-12T01:25:31.801Z", "size_readable": "", "public_url": "https://inexperienced-valuable.name/"}, {"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 72601, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-08-08T03:26:06.485Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-12T01:25:31.801Z", "size_readable": "", "public_url": "https://inexperienced-valuable.name/"}]}, "product_price": {"created_at": "2024-09-29T23:37:22.091Z", "modified_at": null, "id": "", "source": "ad_hoc", "amount_type": "metered_unit", "price_currency": "", "is_archived": false, "product_id": "", "unit_amount": "", "cap_amount": 495203, "meter_id": "", "meter": {"id": "", "name": ""}}, "prices": {"key": [], "key1": []}, "discount": null, "subscription_id": "", "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-09-18T08:05:49.385Z", "modified_at": "2023-01-31T14:16:46.453Z", "id": "", "metadata": {"key": 376311, "key1": "", "key2": 112991}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 115053, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2023-09-18T08:05:49.385Z", "modified_at": "2023-01-31T14:16:46.453Z", "id": "", "metadata": {"key": 376311, "key1": "", "key2": 112991}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 115053, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2023-09-18T08:05:49.385Z", "modified_at": "2023-01-31T14:16:46.453Z", "id": "", "metadata": {"key": 376311, "key1": "", "key2": 112991}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 115053, "required": true}], "customer_metadata": {}} + application/json: {"id": "", "created_at": "2025-08-11T13:37:19.351Z", "modified_at": "2025-01-17T16:36:47.350Z", "payment_processor": "stripe", "status": "expired", "client_secret": "", "url": "https://quiet-longboat.name/", "expires_at": "2024-06-26T17:48:32.882Z", "success_url": "https://flawless-conversation.com/", "return_url": "https://winding-pliers.biz", "embed_origin": "", "amount": 854455, "discount_amount": 294901, "net_amount": 889166, "tax_amount": 922052, "total_amount": 719988, "currency": "Rufiyaa", "allow_trial": false, "active_trial_interval": "year", "active_trial_interval_count": 682201, "trial_end": "2023-04-12T18:01:42.534Z", "organization_id": "", "product_id": "", "product_price_id": "", "discount_id": null, "allow_discount_codes": false, "require_billing_address": true, "is_discount_applicable": false, "is_free_product_price": true, "is_payment_required": true, "is_payment_setup_required": false, "is_payment_form_required": false, "customer_id": "", "is_business_customer": true, "customer_name": null, "customer_email": "", "customer_ip_address": "", "customer_billing_name": "", "customer_billing_address": {"country": "US"}, "customer_tax_id": "", "payment_processor_metadata": {"key": "", "key1": "", "key2": ""}, "billing_address_fields": {"country": "required", "state": "disabled", "city": "disabled", "postal_code": "disabled", "line1": "required", "line2": "required"}, "trial_interval": "month", "trial_interval_count": 495203, "metadata": {"key": 175107, "key1": "", "key2": 598875}, "external_customer_id": "", "products": [{"id": "", "created_at": "2024-10-08T05:33:56.764Z", "modified_at": "2023-07-14T21:58:46.090Z", "trial_interval": null, "trial_interval_count": 186577, "name": "", "description": "where underneath ignorant smoke pearl interesting meh amid", "visibility": "draft", "recurring_interval": null, "recurring_interval_count": 870044, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2025-11-30T19:59:27.996Z", "modified_at": "2023-09-30T23:37:22.091Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "tax_behavior": "exclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2024-06-26T17:48:32.882Z", "modified_at": null, "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "tax_behavior": "exclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}], "benefits": [{"id": "", "created_at": "2024-08-22T08:39:31.775Z", "modified_at": "2024-02-01T17:03:37.242Z", "type": "discord", "description": "overconfidently overplay down unless dilate before optimistically while curly by", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 72601, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-08-08T03:26:06.485Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-12T01:25:31.801Z", "size_readable": "", "public_url": "https://inexperienced-valuable.name/"}, {"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 72601, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-08-08T03:26:06.485Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-12T01:25:31.801Z", "size_readable": "", "public_url": "https://inexperienced-valuable.name/"}, {"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 72601, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-08-08T03:26:06.485Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-12T01:25:31.801Z", "size_readable": "", "public_url": "https://inexperienced-valuable.name/"}]}, {"id": "", "created_at": "2024-10-08T05:33:56.764Z", "modified_at": "2023-07-14T21:58:46.090Z", "trial_interval": "day", "trial_interval_count": 294901, "name": "", "description": "where underneath ignorant smoke pearl interesting meh amid", "visibility": "public", "recurring_interval": null, "recurring_interval_count": 682201, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2025-09-01T12:37:02.777Z", "modified_at": "2025-10-07T13:38:06.522Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "location", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 615287, "legacy": true}, {"created_at": "2024-02-21T06:51:40.935Z", "modified_at": null, "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 391538, "legacy": true}], "benefits": [{"id": "", "created_at": "2024-08-22T08:39:31.775Z", "modified_at": "2024-02-01T17:03:37.242Z", "type": "discord", "description": "overconfidently overplay down unless dilate before optimistically while curly by", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 72601, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-08-08T03:26:06.485Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-12T01:25:31.801Z", "size_readable": "", "public_url": "https://inexperienced-valuable.name/"}, {"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 72601, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-08-08T03:26:06.485Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-12T01:25:31.801Z", "size_readable": "", "public_url": "https://inexperienced-valuable.name/"}, {"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 72601, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-08-08T03:26:06.485Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-12T01:25:31.801Z", "size_readable": "", "public_url": "https://inexperienced-valuable.name/"}]}], "product": {"id": "", "created_at": "2023-09-02T08:09:15.374Z", "modified_at": "2023-01-08T13:18:17.680Z", "trial_interval": "year", "trial_interval_count": 719988, "name": "", "description": null, "visibility": "public", "recurring_interval": "year", "recurring_interval_count": 92838, "is_recurring": false, "is_archived": true, "organization_id": "", "prices": [], "benefits": [{"id": "", "created_at": "2024-08-22T08:39:31.775Z", "modified_at": "2024-02-01T17:03:37.242Z", "type": "discord", "description": "overconfidently overplay down unless dilate before optimistically while curly by", "selectable": false, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2024-08-22T08:39:31.775Z", "modified_at": "2024-02-01T17:03:37.242Z", "type": "discord", "description": "overconfidently overplay down unless dilate before optimistically while curly by", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 72601, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-08-08T03:26:06.485Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-12T01:25:31.801Z", "size_readable": "", "public_url": "https://inexperienced-valuable.name/"}, {"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 72601, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-08-08T03:26:06.485Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-12T01:25:31.801Z", "size_readable": "", "public_url": "https://inexperienced-valuable.name/"}, {"id": "", "organization_id": "", "name": "", "path": "/Applications", "mime_type": "", "size": 72601, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-08-08T03:26:06.485Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-12T01:25:31.801Z", "size_readable": "", "public_url": "https://inexperienced-valuable.name/"}]}, "product_price": {"created_at": "2024-09-29T23:37:22.091Z", "modified_at": null, "id": "", "source": "ad_hoc", "amount_type": "metered_unit", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "unit_amount": "", "cap_amount": 495203, "meter_id": "", "meter": {"id": "", "name": ""}}, "prices": {"key": [], "key1": []}, "discount": null, "subscription_id": "", "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-09-18T08:05:49.385Z", "modified_at": "2023-01-31T14:16:46.453Z", "id": "", "metadata": {"key": 376311, "key1": "", "key2": 112991}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 115053, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2023-09-18T08:05:49.385Z", "modified_at": "2023-01-31T14:16:46.453Z", "id": "", "metadata": {"key": 376311, "key1": "", "key2": 112991}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 115053, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2023-09-18T08:05:49.385Z", "modified_at": "2023-01-31T14:16:46.453Z", "id": "", "metadata": {"key": 376311, "key1": "", "key2": 112991}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 115053, "required": true}], "customer_metadata": {}} "403": application/json: {"error": "AlreadyActiveSubscriptionError", "detail": ""} "404": @@ -2708,7 +2726,7 @@ examples: client_secret: "" responses: "200": - application/json: {"id": "", "created_at": "2025-06-24T05:51:11.116Z", "modified_at": "2025-07-21T02:35:25.261Z", "payment_processor": "stripe", "status": "confirmed", "client_secret": "", "url": "https://simplistic-nudge.net", "expires_at": "2024-08-27T15:59:15.813Z", "success_url": "https://damp-ostrich.net", "return_url": "https://thorny-mathematics.net", "embed_origin": "", "amount": 129651, "discount_amount": 979690, "net_amount": 68566, "tax_amount": 755934, "total_amount": 778145, "currency": "CFA Franc BCEAO", "allow_trial": false, "active_trial_interval": "year", "active_trial_interval_count": 558443, "trial_end": "2025-03-31T17:00:49.512Z", "organization_id": "", "product_id": "", "product_price_id": "", "discount_id": "", "allow_discount_codes": false, "require_billing_address": false, "is_discount_applicable": false, "is_free_product_price": true, "is_payment_required": false, "is_payment_setup_required": false, "is_payment_form_required": false, "customer_id": "", "is_business_customer": false, "customer_name": "", "customer_email": "", "customer_ip_address": "", "customer_billing_name": "", "customer_billing_address": {"country": "US"}, "customer_tax_id": "", "payment_processor_metadata": {"key": "", "key1": ""}, "billing_address_fields": {"country": "disabled", "state": "disabled", "city": "disabled", "postal_code": "optional", "line1": "disabled", "line2": "disabled"}, "products": [{"id": "", "created_at": "2025-11-10T10:55:29.910Z", "modified_at": "2025-02-27T16:08:01.240Z", "trial_interval": "month", "trial_interval_count": 867631, "name": "", "description": "gut yahoo mechanic advancement pace", "visibility": "public", "recurring_interval": "month", "recurring_interval_count": 844979, "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [], "benefits": [{"id": "", "created_at": "2023-03-27T23:50:15.369Z", "modified_at": "2025-11-11T17:18:47.743Z", "type": "github_repository", "description": "whenever valiantly potentially till", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/usr/share", "mime_type": "", "size": 53813, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-04-09T23:56:37.016Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-12-28T20:57:02.041Z", "size_readable": "", "public_url": "https://timely-ice-cream.info"}]}, {"id": "", "created_at": "2025-11-10T10:55:29.910Z", "modified_at": "2025-02-27T16:08:01.240Z", "trial_interval": "month", "trial_interval_count": 173963, "name": "", "description": "gut yahoo mechanic advancement pace", "visibility": "public", "recurring_interval": "month", "recurring_interval_count": 558443, "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [], "benefits": [{"id": "", "created_at": "2023-03-27T23:50:15.369Z", "modified_at": "2025-11-11T17:18:47.743Z", "type": "github_repository", "description": "whenever valiantly potentially till", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/usr/share", "mime_type": "", "size": 53813, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-04-09T23:56:37.016Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-12-28T20:57:02.041Z", "size_readable": "", "public_url": "https://timely-ice-cream.info"}]}], "product": {"id": "", "created_at": "2025-06-13T01:03:58.697Z", "modified_at": "2023-05-03T05:36:23.041Z", "trial_interval": "year", "trial_interval_count": null, "name": "", "description": "blah toward against unhappy hot however", "visibility": "public", "recurring_interval": "year", "recurring_interval_count": 748822, "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2025-07-21T02:35:25.261Z", "modified_at": "2025-05-19T02:18:24.778Z", "id": "", "source": "ad_hoc", "amount_type": "metered_unit", "price_currency": "", "is_archived": false, "product_id": "", "unit_amount": "", "cap_amount": 162606, "meter_id": "", "meter": {"id": "", "name": ""}}, {"created_at": "2023-07-10T15:56:39.492Z", "modified_at": "2025-12-09T17:45:18.853Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2025-03-12T04:59:11.184Z", "modified_at": "2025-06-11T08:05:03.606Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 433632, "legacy": true}], "benefits": [{"id": "", "created_at": "2023-03-27T23:50:15.369Z", "modified_at": "2025-11-11T17:18:47.743Z", "type": "github_repository", "description": "whenever valiantly potentially till", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/usr/share", "mime_type": "", "size": 53813, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-04-09T23:56:37.016Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-12-28T20:57:02.041Z", "size_readable": "", "public_url": "https://timely-ice-cream.info"}, {"id": "", "organization_id": "", "name": "", "path": "/usr/share", "mime_type": "", "size": 53813, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-04-09T23:56:37.016Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-12-28T20:57:02.041Z", "size_readable": "", "public_url": "https://timely-ice-cream.info"}]}, "product_price": {"created_at": "2026-05-19T02:18:24.778Z", "modified_at": "2025-10-29T23:16:41.742Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, "prices": {"key": [{"created_at": "2024-11-20T03:28:45.411Z", "modified_at": "2023-07-10T15:56:39.492Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 950981, "maximum_amount": 731029, "preset_amount": 814176, "legacy": true}], "key1": []}, "discount": {"duration": "once", "type": "percentage", "basis_points": 207850, "id": "", "name": "", "code": ""}, "organization": {"created_at": "2023-11-25T05:44:46.275Z", "modified_at": "2023-04-04T00:17:57.339Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://colorful-packaging.biz", "proration_behavior": "prorate", "allow_customer_updates": false}, "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-07-25T14:36:16.639Z", "modified_at": "2025-08-30T21:44:31.855Z", "id": "", "metadata": {}, "type": "checkbox", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 817087, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2023-07-25T14:36:16.639Z", "modified_at": "2025-08-30T21:44:31.855Z", "id": "", "metadata": {}, "type": "checkbox", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 817087, "required": true}]} + application/json: {"id": "", "created_at": "2025-06-24T05:51:11.116Z", "modified_at": "2025-07-21T02:35:25.261Z", "payment_processor": "stripe", "status": "confirmed", "client_secret": "", "url": "https://simplistic-nudge.net", "expires_at": "2024-08-27T15:59:15.813Z", "success_url": "https://damp-ostrich.net", "return_url": "https://thorny-mathematics.net", "embed_origin": "", "amount": 129651, "discount_amount": 979690, "net_amount": 68566, "tax_amount": 755934, "total_amount": 778145, "currency": "CFA Franc BCEAO", "allow_trial": false, "active_trial_interval": "year", "active_trial_interval_count": 558443, "trial_end": "2025-03-31T17:00:49.512Z", "organization_id": "", "product_id": "", "product_price_id": "", "discount_id": "", "allow_discount_codes": false, "require_billing_address": false, "is_discount_applicable": false, "is_free_product_price": true, "is_payment_required": false, "is_payment_setup_required": false, "is_payment_form_required": false, "customer_id": "", "is_business_customer": false, "customer_name": "", "customer_email": "", "customer_ip_address": "", "customer_billing_name": "", "customer_billing_address": {"country": "US"}, "customer_tax_id": "", "payment_processor_metadata": {"key": "", "key1": ""}, "billing_address_fields": {"country": "disabled", "state": "disabled", "city": "disabled", "postal_code": "optional", "line1": "disabled", "line2": "disabled"}, "products": [{"id": "", "created_at": "2025-11-10T10:55:29.910Z", "modified_at": "2025-02-27T16:08:01.240Z", "trial_interval": "month", "trial_interval_count": 867631, "name": "", "description": "gut yahoo mechanic advancement pace", "visibility": "public", "recurring_interval": "month", "recurring_interval_count": 844979, "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [], "benefits": [{"id": "", "created_at": "2023-03-27T23:50:15.369Z", "modified_at": "2025-11-11T17:18:47.743Z", "type": "github_repository", "description": "whenever valiantly potentially till", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/usr/share", "mime_type": "", "size": 53813, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-04-09T23:56:37.016Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-12-28T20:57:02.041Z", "size_readable": "", "public_url": "https://timely-ice-cream.info"}]}, {"id": "", "created_at": "2025-11-10T10:55:29.910Z", "modified_at": "2025-02-27T16:08:01.240Z", "trial_interval": "month", "trial_interval_count": 173963, "name": "", "description": "gut yahoo mechanic advancement pace", "visibility": "public", "recurring_interval": "month", "recurring_interval_count": 558443, "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [], "benefits": [{"id": "", "created_at": "2023-03-27T23:50:15.369Z", "modified_at": "2025-11-11T17:18:47.743Z", "type": "github_repository", "description": "whenever valiantly potentially till", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/usr/share", "mime_type": "", "size": 53813, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-04-09T23:56:37.016Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-12-28T20:57:02.041Z", "size_readable": "", "public_url": "https://timely-ice-cream.info"}]}], "product": {"id": "", "created_at": "2025-06-13T01:03:58.697Z", "modified_at": "2023-05-03T05:36:23.041Z", "trial_interval": "year", "trial_interval_count": null, "name": "", "description": "blah toward against unhappy hot however", "visibility": "public", "recurring_interval": "year", "recurring_interval_count": 748822, "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2025-07-21T02:35:25.261Z", "modified_at": "2025-05-19T02:18:24.778Z", "id": "", "source": "ad_hoc", "amount_type": "metered_unit", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "unit_amount": "", "cap_amount": 162606, "meter_id": "", "meter": {"id": "", "name": ""}}, {"created_at": "2023-07-10T15:56:39.492Z", "modified_at": "2025-12-09T17:45:18.853Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "tax_behavior": "inclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2025-03-12T04:59:11.184Z", "modified_at": "2025-06-11T08:05:03.606Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "tax_behavior": "exclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 433632, "legacy": true}], "benefits": [{"id": "", "created_at": "2023-03-27T23:50:15.369Z", "modified_at": "2025-11-11T17:18:47.743Z", "type": "github_repository", "description": "whenever valiantly potentially till", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/usr/share", "mime_type": "", "size": 53813, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-04-09T23:56:37.016Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-12-28T20:57:02.041Z", "size_readable": "", "public_url": "https://timely-ice-cream.info"}, {"id": "", "organization_id": "", "name": "", "path": "/usr/share", "mime_type": "", "size": 53813, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-04-09T23:56:37.016Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-12-28T20:57:02.041Z", "size_readable": "", "public_url": "https://timely-ice-cream.info"}]}, "product_price": {"created_at": "2026-05-19T02:18:24.778Z", "modified_at": "2025-10-29T23:16:41.742Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, "prices": {"key": [{"created_at": "2024-11-20T03:28:45.411Z", "modified_at": "2023-07-10T15:56:39.492Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 950981, "maximum_amount": 731029, "preset_amount": 814176, "legacy": true}], "key1": []}, "discount": {"duration": "once", "type": "percentage", "basis_points": 207850, "id": "", "name": "", "code": ""}, "organization": {"created_at": "2023-11-25T05:44:46.275Z", "modified_at": "2023-04-04T00:17:57.339Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://colorful-packaging.biz", "proration_behavior": "prorate", "allow_customer_updates": false}, "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-07-25T14:36:16.639Z", "modified_at": "2025-08-30T21:44:31.855Z", "id": "", "metadata": {}, "type": "checkbox", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 817087, "required": true}, {"custom_field_id": "", "custom_field": {"created_at": "2023-07-25T14:36:16.639Z", "modified_at": "2025-08-30T21:44:31.855Z", "id": "", "metadata": {}, "type": "checkbox", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 817087, "required": true}]} "404": application/json: {"error": "ResourceNotFound", "detail": ""} "410": @@ -2724,7 +2742,7 @@ examples: application/json: {"customer_name": "John Doe", "customer_billing_address": null, "locale": "en", "allow_trial": false} responses: "200": - application/json: {"id": "", "created_at": "2024-07-23T03:29:25.334Z", "modified_at": "2023-09-18T08:32:05.837Z", "payment_processor": "stripe", "status": "expired", "client_secret": "", "url": "https://oddball-final.com", "expires_at": "2024-03-02T01:02:20.912Z", "success_url": "https://illiterate-ownership.com/", "return_url": null, "embed_origin": "", "amount": 566134, "discount_amount": 108102, "net_amount": 304494, "tax_amount": 824826, "total_amount": 528924, "currency": "Comoro Franc", "allow_trial": null, "active_trial_interval": null, "active_trial_interval_count": 192380, "trial_end": "2023-10-31T15:08:35.342Z", "organization_id": "", "product_id": "", "product_price_id": null, "discount_id": "", "allow_discount_codes": true, "require_billing_address": true, "is_discount_applicable": false, "is_free_product_price": true, "is_payment_required": true, "is_payment_setup_required": false, "is_payment_form_required": false, "customer_id": "", "is_business_customer": true, "customer_name": "", "customer_email": "", "customer_ip_address": "", "customer_billing_name": "", "customer_billing_address": {"country": "US"}, "customer_tax_id": "", "payment_processor_metadata": {"key": ""}, "billing_address_fields": {"country": "required", "state": "optional", "city": "required", "postal_code": "required", "line1": "required", "line2": "disabled"}, "products": [{"id": "", "created_at": "2025-08-18T21:55:12.162Z", "modified_at": "2024-12-17T22:23:13.690Z", "trial_interval": "month", "trial_interval_count": 138062, "name": "", "description": "instead divert indeed oh phrase fisherman bowling but upon airmail", "visibility": "draft", "recurring_interval": "year", "recurring_interval_count": null, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2023-07-30T20:21:38.608Z", "modified_at": "2023-10-31T15:08:35.342Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 330194, "legacy": true}, {"created_at": "2023-08-03T11:06:01.091Z", "modified_at": "2024-11-28T20:27:45.245Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 566134, "legacy": true}], "benefits": [{"id": "", "created_at": "2023-04-25T20:23:37.760Z", "modified_at": "2023-11-02T06:39:34.543Z", "type": "custom", "description": "rebuke sun intensely", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 291762, "storage_version": null, "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-09-23T19:57:40.076Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-20T03:17:22.448Z", "size_readable": "", "public_url": "https://valuable-declaration.info"}, {"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 291762, "storage_version": null, "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-09-23T19:57:40.076Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-20T03:17:22.448Z", "size_readable": "", "public_url": "https://valuable-declaration.info"}]}], "product": {"id": "", "created_at": "2024-01-05T10:50:28.777Z", "modified_at": "2024-04-21T11:49:06.390Z", "trial_interval": "day", "trial_interval_count": 636727, "name": "", "description": null, "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 192380, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2025-11-16T12:17:31.920Z", "modified_at": "2024-08-02T16:48:24.620Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 67913, "maximum_amount": 437805, "preset_amount": 546487, "legacy": true}, {"created_at": "2024-02-08T00:22:42.494Z", "modified_at": "2025-10-13T00:42:35.938Z", "id": "", "source": "catalog", "amount_type": "metered_unit", "price_currency": "", "is_archived": false, "product_id": "", "unit_amount": "", "cap_amount": 317412, "meter_id": "", "meter": {"id": "", "name": ""}}], "benefits": [{"id": "", "created_at": "2023-04-25T20:23:37.760Z", "modified_at": "2023-11-02T06:39:34.543Z", "type": "custom", "description": "rebuke sun intensely", "selectable": false, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2023-04-25T20:23:37.760Z", "modified_at": "2023-11-02T06:39:34.543Z", "type": "custom", "description": "rebuke sun intensely", "selectable": false, "deletable": false, "organization_id": ""}], "medias": []}, "product_price": {"created_at": "2024-10-30T15:08:35.342Z", "modified_at": "2025-09-15T04:58:49.882Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "week", "minimum_amount": 195677, "maximum_amount": 636727, "preset_amount": 784848, "legacy": true}, "prices": {"key": []}, "discount": {"duration": "repeating", "type": "percentage", "basis_points": 639439, "id": "", "name": "", "code": null}, "organization": {"created_at": "2023-09-07T11:25:07.070Z", "modified_at": "2023-05-12T10:01:16.059Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://mixed-netsuke.com/", "proration_behavior": "invoice", "allow_customer_updates": true}, "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-03-31T08:25:33.432Z", "modified_at": "2025-12-17T08:24:12.865Z", "id": "", "metadata": {}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 439492, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2023-03-31T08:25:33.432Z", "modified_at": "2025-12-17T08:24:12.865Z", "id": "", "metadata": {}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 439492, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2023-03-31T08:25:33.432Z", "modified_at": "2025-12-17T08:24:12.865Z", "id": "", "metadata": {}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 439492, "required": false}]} + application/json: {"id": "", "created_at": "2024-07-23T03:29:25.334Z", "modified_at": "2023-09-18T08:32:05.837Z", "payment_processor": "stripe", "status": "expired", "client_secret": "", "url": "https://oddball-final.com", "expires_at": "2024-03-02T01:02:20.912Z", "success_url": "https://illiterate-ownership.com/", "return_url": null, "embed_origin": "", "amount": 566134, "discount_amount": 108102, "net_amount": 304494, "tax_amount": 824826, "total_amount": 528924, "currency": "Comoro Franc", "allow_trial": null, "active_trial_interval": null, "active_trial_interval_count": 192380, "trial_end": "2023-10-31T15:08:35.342Z", "organization_id": "", "product_id": "", "product_price_id": null, "discount_id": "", "allow_discount_codes": true, "require_billing_address": true, "is_discount_applicable": false, "is_free_product_price": true, "is_payment_required": true, "is_payment_setup_required": false, "is_payment_form_required": false, "customer_id": "", "is_business_customer": true, "customer_name": "", "customer_email": "", "customer_ip_address": "", "customer_billing_name": "", "customer_billing_address": {"country": "US"}, "customer_tax_id": "", "payment_processor_metadata": {"key": ""}, "billing_address_fields": {"country": "required", "state": "optional", "city": "required", "postal_code": "required", "line1": "required", "line2": "disabled"}, "products": [{"id": "", "created_at": "2025-08-18T21:55:12.162Z", "modified_at": "2024-12-17T22:23:13.690Z", "trial_interval": "month", "trial_interval_count": 138062, "name": "", "description": "instead divert indeed oh phrase fisherman bowling but upon airmail", "visibility": "draft", "recurring_interval": "year", "recurring_interval_count": null, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2023-07-30T20:21:38.608Z", "modified_at": "2023-10-31T15:08:35.342Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "tax_behavior": null, "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 330194, "legacy": true}, {"created_at": "2023-08-03T11:06:01.091Z", "modified_at": "2024-11-28T20:27:45.245Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 566134, "legacy": true}], "benefits": [{"id": "", "created_at": "2023-04-25T20:23:37.760Z", "modified_at": "2023-11-02T06:39:34.543Z", "type": "custom", "description": "rebuke sun intensely", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 291762, "storage_version": null, "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-09-23T19:57:40.076Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-20T03:17:22.448Z", "size_readable": "", "public_url": "https://valuable-declaration.info"}, {"id": "", "organization_id": "", "name": "", "path": "/sbin", "mime_type": "", "size": 291762, "storage_version": null, "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-09-23T19:57:40.076Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-20T03:17:22.448Z", "size_readable": "", "public_url": "https://valuable-declaration.info"}]}], "product": {"id": "", "created_at": "2024-01-05T10:50:28.777Z", "modified_at": "2024-04-21T11:49:06.390Z", "trial_interval": "day", "trial_interval_count": 636727, "name": "", "description": null, "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 192380, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2025-11-16T12:17:31.920Z", "modified_at": "2024-08-02T16:48:24.620Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 67913, "maximum_amount": 437805, "preset_amount": 546487, "legacy": true}, {"created_at": "2024-02-08T00:22:42.494Z", "modified_at": "2025-10-13T00:42:35.938Z", "id": "", "source": "catalog", "amount_type": "metered_unit", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "unit_amount": "", "cap_amount": 317412, "meter_id": "", "meter": {"id": "", "name": ""}}], "benefits": [{"id": "", "created_at": "2023-04-25T20:23:37.760Z", "modified_at": "2023-11-02T06:39:34.543Z", "type": "custom", "description": "rebuke sun intensely", "selectable": false, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2023-04-25T20:23:37.760Z", "modified_at": "2023-11-02T06:39:34.543Z", "type": "custom", "description": "rebuke sun intensely", "selectable": false, "deletable": false, "organization_id": ""}], "medias": []}, "product_price": {"created_at": "2024-10-30T15:08:35.342Z", "modified_at": "2025-09-15T04:58:49.882Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "week", "minimum_amount": 195677, "maximum_amount": 636727, "preset_amount": 784848, "legacy": true}, "prices": {"key": []}, "discount": {"duration": "repeating", "type": "percentage", "basis_points": 639439, "id": "", "name": "", "code": null}, "organization": {"created_at": "2023-09-07T11:25:07.070Z", "modified_at": "2023-05-12T10:01:16.059Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://mixed-netsuke.com/", "proration_behavior": "invoice", "allow_customer_updates": true}, "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2023-03-31T08:25:33.432Z", "modified_at": "2025-12-17T08:24:12.865Z", "id": "", "metadata": {}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 439492, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2023-03-31T08:25:33.432Z", "modified_at": "2025-12-17T08:24:12.865Z", "id": "", "metadata": {}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 439492, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2023-03-31T08:25:33.432Z", "modified_at": "2025-12-17T08:24:12.865Z", "id": "", "metadata": {}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 439492, "required": false}]} "403": application/json: {"error": "AlreadyActiveSubscriptionError", "detail": ""} "404": @@ -2742,7 +2760,7 @@ examples: application/json: {"customer_name": "John Doe", "customer_billing_address": {"country": "US"}, "locale": "en", "allow_trial": false} responses: "200": - application/json: {"id": "", "created_at": "2023-03-02T01:35:00.551Z", "modified_at": "2024-02-06T20:08:33.394Z", "payment_processor": "stripe", "status": "confirmed", "client_secret": "", "url": "https://earnest-mountain.biz/", "expires_at": "2023-05-03T06:41:51.564Z", "success_url": "https://amazing-airmail.biz", "return_url": "https://tinted-fun.com/", "embed_origin": "", "amount": 340812, "discount_amount": 983591, "net_amount": 119432, "tax_amount": 315526, "total_amount": 280139, "currency": "Lek", "allow_trial": true, "active_trial_interval": "day", "active_trial_interval_count": 366642, "trial_end": null, "organization_id": "", "product_id": "", "product_price_id": "", "discount_id": "", "allow_discount_codes": true, "require_billing_address": false, "is_discount_applicable": true, "is_free_product_price": true, "is_payment_required": true, "is_payment_setup_required": true, "is_payment_form_required": true, "customer_id": "", "is_business_customer": true, "customer_name": "", "customer_email": "", "customer_ip_address": "", "customer_billing_name": "", "customer_billing_address": {"country": "US"}, "customer_tax_id": "", "payment_processor_metadata": {"key": ""}, "billing_address_fields": {"country": "required", "state": "required", "city": "disabled", "postal_code": "optional", "line1": "required", "line2": "required"}, "products": [], "product": {"id": "", "created_at": "2023-12-22T07:23:53.362Z", "modified_at": null, "trial_interval": "month", "trial_interval_count": 111568, "name": "", "description": null, "visibility": "draft", "recurring_interval": "month", "recurring_interval_count": 54804, "is_recurring": false, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2025-07-29T04:50:02.330Z", "modified_at": "2023-01-09T13:54:39.340Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 111568, "maximum_amount": 27642, "preset_amount": null, "legacy": true}, {"created_at": "2024-01-09T12:43:40.308Z", "modified_at": "2023-05-11T21:32:37.055Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 280139, "legacy": true}, {"created_at": "2024-03-30T19:58:01.924Z", "modified_at": "2023-04-26T10:07:32.939Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 304892, "maximum_amount": 308257, "preset_amount": 774216, "legacy": true}], "benefits": [{"id": "", "created_at": "2025-02-20T06:26:56.148Z", "modified_at": "2024-03-08T22:44:58.041Z", "type": "downloadables", "description": "jovially condense sleepy as porter interior forage which", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/sys", "mime_type": "", "size": 923962, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-11-15T18:38:57.765Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-04-15T23:25:20.301Z", "size_readable": "", "public_url": "https://measly-transparency.biz"}, {"id": "", "organization_id": "", "name": "", "path": "/sys", "mime_type": "", "size": 923962, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-11-15T18:38:57.765Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-04-15T23:25:20.301Z", "size_readable": "", "public_url": "https://measly-transparency.biz"}, {"id": "", "organization_id": "", "name": "", "path": "/sys", "mime_type": "", "size": 923962, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-11-15T18:38:57.765Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-04-15T23:25:20.301Z", "size_readable": "", "public_url": "https://measly-transparency.biz"}]}, "product_price": null, "prices": {"key": []}, "discount": {"duration": "repeating", "duration_in_months": 54804, "type": "fixed", "amount": 794922, "currency": "Lilangeni", "amounts": {"eur": 900, "usd": 1000}, "id": "", "name": "", "code": ""}, "organization": {"created_at": "2023-03-10T13:26:15.309Z", "modified_at": "2025-01-22T15:08:25.650Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": null, "proration_behavior": "prorate", "allow_customer_updates": true}, "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-06-01T04:51:14.846Z", "modified_at": "2023-04-07T11:22:11.779Z", "id": "", "metadata": {"key": ""}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 256145, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2024-06-01T04:51:14.846Z", "modified_at": "2023-04-07T11:22:11.779Z", "id": "", "metadata": {"key": ""}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 256145, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2024-06-01T04:51:14.846Z", "modified_at": "2023-04-07T11:22:11.779Z", "id": "", "metadata": {"key": ""}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 256145, "required": false}], "customer_session_token": ""} + application/json: {"id": "", "created_at": "2023-03-02T01:35:00.551Z", "modified_at": "2024-02-06T20:08:33.394Z", "payment_processor": "stripe", "status": "confirmed", "client_secret": "", "url": "https://earnest-mountain.biz/", "expires_at": "2023-05-03T06:41:51.564Z", "success_url": "https://amazing-airmail.biz", "return_url": "https://tinted-fun.com/", "embed_origin": "", "amount": 340812, "discount_amount": 983591, "net_amount": 119432, "tax_amount": 315526, "total_amount": 280139, "currency": "Lek", "allow_trial": true, "active_trial_interval": "day", "active_trial_interval_count": 366642, "trial_end": null, "organization_id": "", "product_id": "", "product_price_id": "", "discount_id": "", "allow_discount_codes": true, "require_billing_address": false, "is_discount_applicable": true, "is_free_product_price": true, "is_payment_required": true, "is_payment_setup_required": true, "is_payment_form_required": true, "customer_id": "", "is_business_customer": true, "customer_name": "", "customer_email": "", "customer_ip_address": "", "customer_billing_name": "", "customer_billing_address": {"country": "US"}, "customer_tax_id": "", "payment_processor_metadata": {"key": ""}, "billing_address_fields": {"country": "required", "state": "required", "city": "disabled", "postal_code": "optional", "line1": "required", "line2": "required"}, "products": [], "product": {"id": "", "created_at": "2023-12-22T07:23:53.362Z", "modified_at": null, "trial_interval": "month", "trial_interval_count": 111568, "name": "", "description": null, "visibility": "draft", "recurring_interval": "month", "recurring_interval_count": 54804, "is_recurring": false, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2025-07-29T04:50:02.330Z", "modified_at": "2023-01-09T13:54:39.340Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 111568, "maximum_amount": 27642, "preset_amount": null, "legacy": true}, {"created_at": "2024-01-09T12:43:40.308Z", "modified_at": "2023-05-11T21:32:37.055Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 280139, "legacy": true}, {"created_at": "2024-03-30T19:58:01.924Z", "modified_at": "2023-04-26T10:07:32.939Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": null, "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 304892, "maximum_amount": 308257, "preset_amount": 774216, "legacy": true}], "benefits": [{"id": "", "created_at": "2025-02-20T06:26:56.148Z", "modified_at": "2024-03-08T22:44:58.041Z", "type": "downloadables", "description": "jovially condense sleepy as porter interior forage which", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/sys", "mime_type": "", "size": 923962, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-11-15T18:38:57.765Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-04-15T23:25:20.301Z", "size_readable": "", "public_url": "https://measly-transparency.biz"}, {"id": "", "organization_id": "", "name": "", "path": "/sys", "mime_type": "", "size": 923962, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-11-15T18:38:57.765Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-04-15T23:25:20.301Z", "size_readable": "", "public_url": "https://measly-transparency.biz"}, {"id": "", "organization_id": "", "name": "", "path": "/sys", "mime_type": "", "size": 923962, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2023-11-15T18:38:57.765Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-04-15T23:25:20.301Z", "size_readable": "", "public_url": "https://measly-transparency.biz"}]}, "product_price": null, "prices": {"key": []}, "discount": {"duration": "repeating", "duration_in_months": 54804, "type": "fixed", "amount": 794922, "currency": "Lilangeni", "amounts": {"eur": 900, "usd": 1000}, "id": "", "name": "", "code": ""}, "organization": {"created_at": "2023-03-10T13:26:15.309Z", "modified_at": "2025-01-22T15:08:25.650Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": null, "proration_behavior": "prorate", "allow_customer_updates": true}, "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-06-01T04:51:14.846Z", "modified_at": "2023-04-07T11:22:11.779Z", "id": "", "metadata": {"key": ""}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 256145, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2024-06-01T04:51:14.846Z", "modified_at": "2023-04-07T11:22:11.779Z", "id": "", "metadata": {"key": ""}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 256145, "required": false}, {"custom_field_id": "", "custom_field": {"created_at": "2024-06-01T04:51:14.846Z", "modified_at": "2023-04-07T11:22:11.779Z", "id": "", "metadata": {"key": ""}, "type": "number", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 256145, "required": false}], "customer_session_token": ""} "400": application/json: {"error": "PaymentError", "detail": ""} "403": @@ -2829,7 +2847,7 @@ examples: timezone: "UTC" responses: "200": - application/json: {"periods": [{"timestamp": "2024-11-05T16:37:46.152Z", "active_subscriptions": 1692.89, "monthly_recurring_revenue": 5809.97, "committed_monthly_recurring_revenue": 7366.16, "average_revenue_per_user": 7366.16, "checkouts": 6229.46, "succeeded_checkouts": 464.75, "orders": 2313.41, "revenue": 3697.18, "net_revenue": 7366.16, "cumulative_revenue": 160547, "net_cumulative_revenue": 620.86, "costs": 7366.16, "cumulative_costs": 620.86, "average_order_value": 8348.91, "net_average_order_value": 615596, "cost_per_user": 620.86, "active_user_by_event": 615596, "one_time_products": 6315.62, "one_time_products_revenue": 271957, "one_time_products_net_revenue": 2313.41, "new_subscriptions": 225346, "new_subscriptions_revenue": 5903.37, "new_subscriptions_net_revenue": 3697.18, "renewed_subscriptions": 146.2, "renewed_subscriptions_revenue": 3772.41, "renewed_subscriptions_net_revenue": 160547, "canceled_subscriptions": 7366.16, "canceled_subscriptions_customer_service": 620.86, "canceled_subscriptions_low_quality": 615596, "canceled_subscriptions_missing_features": 2313.41, "canceled_subscriptions_switched_service": 3697.18, "canceled_subscriptions_too_complex": 160547, "canceled_subscriptions_too_expensive": 8348.91, "canceled_subscriptions_unused": 6315.62, "canceled_subscriptions_other": 271957, "checkouts_conversion": 536209, "churn_rate": 2313.41, "gross_margin": 3697.18, "gross_margin_percentage": 160547, "cashflow": 8348.91}], "totals": {}, "metrics": {}} + application/json: {"periods": [{"timestamp": "2024-11-05T16:37:46.152Z", "active_subscriptions": 1692.89, "monthly_recurring_revenue": 5809.97, "committed_monthly_recurring_revenue": 7366.16, "average_revenue_per_user": 7366.16, "checkouts": 6229.46, "succeeded_checkouts": 464.75, "churn_rate": 2313.41, "orders": 2313.41, "revenue": 3697.18, "net_revenue": 7366.16, "cumulative_revenue": 160547, "net_cumulative_revenue": 620.86, "costs": 7366.16, "cumulative_costs": 620.86, "average_order_value": 8348.91, "net_average_order_value": 615596, "cost_per_user": 620.86, "active_user_by_event": 615596, "one_time_products": 6315.62, "one_time_products_revenue": 271957, "one_time_products_net_revenue": 2313.41, "new_subscriptions": 225346, "new_subscriptions_revenue": 5903.37, "new_subscriptions_net_revenue": 3697.18, "renewed_subscriptions": 146.2, "renewed_subscriptions_revenue": 3772.41, "renewed_subscriptions_net_revenue": 160547, "canceled_subscriptions": 7366.16, "canceled_subscriptions_customer_service": 620.86, "canceled_subscriptions_low_quality": 615596, "canceled_subscriptions_missing_features": 2313.41, "canceled_subscriptions_switched_service": 3697.18, "canceled_subscriptions_too_complex": 160547, "canceled_subscriptions_too_expensive": 8348.91, "canceled_subscriptions_unused": 6315.62, "canceled_subscriptions_other": 271957, "checkouts_conversion": 536209, "gross_margin": 3697.18, "gross_margin_percentage": 160547, "cashflow": 8348.91}], "totals": {}, "metrics": {}} "422": application/json: {} metrics:limits: @@ -2907,7 +2925,7 @@ examples: limit: 10 responses: "200": - application/json: {"items": [{"id": "", "created_at": "2024-12-08T18:31:28.967Z", "modified_at": "2025-08-25T12:12:46.370Z", "trial_interval": "year", "trial_interval_count": 379186, "metadata": {"key": 269522}, "payment_processor": "stripe", "client_secret": "", "success_url": "https://wretched-peony.com/", "return_url": "https://punctual-glider.org", "label": "", "allow_discount_codes": false, "require_billing_address": false, "discount_id": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "products": [{"metadata": {"key": false}, "id": "", "created_at": "2025-06-23T06:29:06.861Z", "modified_at": "2024-05-30T08:30:33.019Z", "trial_interval": "week", "trial_interval_count": 269522, "name": "", "description": "partially yellow gadzooks gleefully reassuringly qua around", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 962255, "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2024-12-08T18:31:28.967Z", "modified_at": "2025-08-25T12:12:46.370Z", "id": "", "source": "ad_hoc", "amount_type": "metered_unit", "price_currency": "", "is_archived": true, "product_id": "", "unit_amount": "", "cap_amount": 987277, "meter_id": "", "meter": {"id": "", "name": ""}}, {"created_at": "2025-02-11T18:32:20.472Z", "modified_at": "2025-03-25T11:30:39.715Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 825064, "maximum_amount": 470214, "preset_amount": 586539, "legacy": true}], "benefits": [{"id": "", "created_at": "2025-01-11T23:38:31.265Z", "modified_at": "2023-05-01T01:24:54.811Z", "type": "downloadables", "description": "gosh french or slow bin competent tuba follower oof", "selectable": false, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-01-11T23:38:31.265Z", "modified_at": "2023-05-01T01:24:54.811Z", "type": "downloadables", "description": "gosh french or slow bin competent tuba follower oof", "selectable": false, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-01-11T23:38:31.265Z", "modified_at": "2023-05-01T01:24:54.811Z", "type": "downloadables", "description": "gosh french or slow bin competent tuba follower oof", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Library", "mime_type": "", "size": 397996, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-12-04T19:29:48.554Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-11-06T19:24:06.160Z", "size_readable": "", "public_url": "https://pitiful-flint.org"}, {"id": "", "organization_id": "", "name": "", "path": "/Library", "mime_type": "", "size": 397996, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-12-04T19:29:48.554Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-11-06T19:24:06.160Z", "size_readable": "", "public_url": "https://pitiful-flint.org"}]}], "discount": {"duration": "once", "duration_in_months": 354366, "type": "fixed", "basis_points": 140653, "created_at": "2024-08-19T15:49:46.374Z", "modified_at": "2024-11-08T09:13:07.988Z", "id": "", "metadata": {"key": 6965.21, "key1": 727000}, "name": "", "code": "", "starts_at": "2023-08-16T05:03:04.814Z", "ends_at": "2023-11-17T21:19:16.987Z", "max_redemptions": 65553, "redemptions_count": 331792, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "url": "https://forsaken-hamburger.info/"}, {"id": "", "created_at": "2024-12-08T18:31:28.967Z", "modified_at": "2025-08-25T12:12:46.370Z", "trial_interval": "week", "trial_interval_count": 656194, "metadata": {"key": 269522}, "payment_processor": "stripe", "client_secret": "", "success_url": "https://wretched-peony.com/", "return_url": "https://uniform-gallery.org/", "label": "", "allow_discount_codes": false, "require_billing_address": false, "discount_id": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "products": [{"metadata": {"key": false}, "id": "", "created_at": "2025-06-23T06:29:06.861Z", "modified_at": "2024-05-30T08:30:33.019Z", "trial_interval": "month", "trial_interval_count": 743139, "name": "", "description": "partially yellow gadzooks gleefully reassuringly qua around", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 379186, "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2023-05-11T01:12:44.937Z", "modified_at": "2025-06-06T13:16:03.281Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2025-01-30T11:54:59.602Z", "modified_at": "2025-12-23T14:11:20.089Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 267903, "legacy": true}], "benefits": [{"id": "", "created_at": "2025-01-11T23:38:31.265Z", "modified_at": "2023-05-01T01:24:54.811Z", "type": "downloadables", "description": "gosh french or slow bin competent tuba follower oof", "selectable": false, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-01-11T23:38:31.265Z", "modified_at": "2023-05-01T01:24:54.811Z", "type": "downloadables", "description": "gosh french or slow bin competent tuba follower oof", "selectable": false, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-01-11T23:38:31.265Z", "modified_at": "2023-05-01T01:24:54.811Z", "type": "downloadables", "description": "gosh french or slow bin competent tuba follower oof", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Library", "mime_type": "", "size": 397996, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-12-04T19:29:48.554Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-11-06T19:24:06.160Z", "size_readable": "", "public_url": "https://pitiful-flint.org"}, {"id": "", "organization_id": "", "name": "", "path": "/Library", "mime_type": "", "size": 397996, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-12-04T19:29:48.554Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-11-06T19:24:06.160Z", "size_readable": "", "public_url": "https://pitiful-flint.org"}]}], "discount": {"duration": "once", "duration_in_months": 354366, "type": "fixed", "basis_points": 140653, "created_at": "2024-08-19T15:49:46.374Z", "modified_at": "2024-11-08T09:13:07.988Z", "id": "", "metadata": {"key": 6965.21, "key1": 727000}, "name": "", "code": "", "starts_at": "2023-08-16T05:03:04.814Z", "ends_at": "2023-11-17T21:19:16.987Z", "max_redemptions": 65553, "redemptions_count": 331792, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "url": "https://forsaken-hamburger.info/"}, {"id": "", "created_at": "2024-12-08T18:31:28.967Z", "modified_at": "2025-08-25T12:12:46.370Z", "trial_interval": "week", "trial_interval_count": 958373, "metadata": {"key": 269522}, "payment_processor": "stripe", "client_secret": "", "success_url": "https://wretched-peony.com/", "return_url": "https://tidy-reorganisation.org", "label": "", "allow_discount_codes": false, "require_billing_address": false, "discount_id": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "products": [{"metadata": {"key": false}, "id": "", "created_at": "2025-06-23T06:29:06.861Z", "modified_at": "2024-05-30T08:30:33.019Z", "trial_interval": "year", "trial_interval_count": 470214, "name": "", "description": "partially yellow gadzooks gleefully reassuringly qua around", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 438333, "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2025-07-07T18:45:01.201Z", "modified_at": "2023-05-16T12:45:34.730Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}, {"created_at": "2023-04-05T16:33:44.616Z", "modified_at": "2023-12-19T09:15:06.533Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 363007, "legacy": true}], "benefits": [{"id": "", "created_at": "2025-01-11T23:38:31.265Z", "modified_at": "2023-05-01T01:24:54.811Z", "type": "downloadables", "description": "gosh french or slow bin competent tuba follower oof", "selectable": false, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-01-11T23:38:31.265Z", "modified_at": "2023-05-01T01:24:54.811Z", "type": "downloadables", "description": "gosh french or slow bin competent tuba follower oof", "selectable": false, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-01-11T23:38:31.265Z", "modified_at": "2023-05-01T01:24:54.811Z", "type": "downloadables", "description": "gosh french or slow bin competent tuba follower oof", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Library", "mime_type": "", "size": 397996, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-12-04T19:29:48.554Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-11-06T19:24:06.160Z", "size_readable": "", "public_url": "https://pitiful-flint.org"}, {"id": "", "organization_id": "", "name": "", "path": "/Library", "mime_type": "", "size": 397996, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-12-04T19:29:48.554Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-11-06T19:24:06.160Z", "size_readable": "", "public_url": "https://pitiful-flint.org"}]}], "discount": {"duration": "once", "duration_in_months": 354366, "type": "fixed", "basis_points": 140653, "created_at": "2024-08-19T15:49:46.374Z", "modified_at": "2024-11-08T09:13:07.988Z", "id": "", "metadata": {"key": 6965.21, "key1": 727000}, "name": "", "code": "", "starts_at": "2023-08-16T05:03:04.814Z", "ends_at": "2023-11-17T21:19:16.987Z", "max_redemptions": 65553, "redemptions_count": 331792, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "url": "https://forsaken-hamburger.info/"}], "pagination": {"total_count": 226341, "max_page": 804607}} + application/json: {"items": [{"id": "", "created_at": "2024-12-08T18:31:28.967Z", "modified_at": "2025-08-25T12:12:46.370Z", "trial_interval": "year", "trial_interval_count": 379186, "metadata": {"key": 269522}, "payment_processor": "stripe", "client_secret": "", "success_url": "https://wretched-peony.com/", "return_url": "https://punctual-glider.org", "label": "", "allow_discount_codes": false, "require_billing_address": false, "discount_id": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "products": [{"metadata": {"key": false}, "id": "", "created_at": "2025-06-23T06:29:06.861Z", "modified_at": "2024-05-30T08:30:33.019Z", "trial_interval": "week", "trial_interval_count": 269522, "name": "", "description": "partially yellow gadzooks gleefully reassuringly qua around", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 962255, "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2024-12-08T18:31:28.967Z", "modified_at": "2025-08-25T12:12:46.370Z", "id": "", "source": "ad_hoc", "amount_type": "metered_unit", "price_currency": "", "tax_behavior": "exclusive", "is_archived": true, "product_id": "", "unit_amount": "", "cap_amount": 987277, "meter_id": "", "meter": {"id": "", "name": ""}}, {"created_at": "2025-02-11T18:32:20.472Z", "modified_at": "2025-03-25T11:30:39.715Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 825064, "maximum_amount": 470214, "preset_amount": 586539, "legacy": true}], "benefits": [{"id": "", "created_at": "2025-01-11T23:38:31.265Z", "modified_at": "2023-05-01T01:24:54.811Z", "type": "downloadables", "description": "gosh french or slow bin competent tuba follower oof", "selectable": false, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-01-11T23:38:31.265Z", "modified_at": "2023-05-01T01:24:54.811Z", "type": "downloadables", "description": "gosh french or slow bin competent tuba follower oof", "selectable": false, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-01-11T23:38:31.265Z", "modified_at": "2023-05-01T01:24:54.811Z", "type": "downloadables", "description": "gosh french or slow bin competent tuba follower oof", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Library", "mime_type": "", "size": 397996, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-12-04T19:29:48.554Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-11-06T19:24:06.160Z", "size_readable": "", "public_url": "https://pitiful-flint.org"}, {"id": "", "organization_id": "", "name": "", "path": "/Library", "mime_type": "", "size": 397996, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-12-04T19:29:48.554Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-11-06T19:24:06.160Z", "size_readable": "", "public_url": "https://pitiful-flint.org"}]}], "discount": {"duration": "once", "duration_in_months": 354366, "type": "fixed", "basis_points": 140653, "created_at": "2024-08-19T15:49:46.374Z", "modified_at": "2024-11-08T09:13:07.988Z", "id": "", "metadata": {"key": 6965.21, "key1": 727000}, "name": "", "code": "", "starts_at": "2023-08-16T05:03:04.814Z", "ends_at": "2023-11-17T21:19:16.987Z", "max_redemptions": 65553, "redemptions_count": 331792, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "url": "https://forsaken-hamburger.info/"}, {"id": "", "created_at": "2024-12-08T18:31:28.967Z", "modified_at": "2025-08-25T12:12:46.370Z", "trial_interval": "week", "trial_interval_count": 656194, "metadata": {"key": 269522}, "payment_processor": "stripe", "client_secret": "", "success_url": "https://wretched-peony.com/", "return_url": "https://uniform-gallery.org/", "label": "", "allow_discount_codes": false, "require_billing_address": false, "discount_id": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "products": [{"metadata": {"key": false}, "id": "", "created_at": "2025-06-23T06:29:06.861Z", "modified_at": "2024-05-30T08:30:33.019Z", "trial_interval": "month", "trial_interval_count": 743139, "name": "", "description": "partially yellow gadzooks gleefully reassuringly qua around", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 379186, "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2023-05-11T01:12:44.937Z", "modified_at": "2025-06-06T13:16:03.281Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "tax_behavior": "inclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2025-01-30T11:54:59.602Z", "modified_at": "2025-12-23T14:11:20.089Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "location", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 267903, "legacy": true}], "benefits": [{"id": "", "created_at": "2025-01-11T23:38:31.265Z", "modified_at": "2023-05-01T01:24:54.811Z", "type": "downloadables", "description": "gosh french or slow bin competent tuba follower oof", "selectable": false, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-01-11T23:38:31.265Z", "modified_at": "2023-05-01T01:24:54.811Z", "type": "downloadables", "description": "gosh french or slow bin competent tuba follower oof", "selectable": false, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-01-11T23:38:31.265Z", "modified_at": "2023-05-01T01:24:54.811Z", "type": "downloadables", "description": "gosh french or slow bin competent tuba follower oof", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Library", "mime_type": "", "size": 397996, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-12-04T19:29:48.554Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-11-06T19:24:06.160Z", "size_readable": "", "public_url": "https://pitiful-flint.org"}, {"id": "", "organization_id": "", "name": "", "path": "/Library", "mime_type": "", "size": 397996, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-12-04T19:29:48.554Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-11-06T19:24:06.160Z", "size_readable": "", "public_url": "https://pitiful-flint.org"}]}], "discount": {"duration": "once", "duration_in_months": 354366, "type": "fixed", "basis_points": 140653, "created_at": "2024-08-19T15:49:46.374Z", "modified_at": "2024-11-08T09:13:07.988Z", "id": "", "metadata": {"key": 6965.21, "key1": 727000}, "name": "", "code": "", "starts_at": "2023-08-16T05:03:04.814Z", "ends_at": "2023-11-17T21:19:16.987Z", "max_redemptions": 65553, "redemptions_count": 331792, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "url": "https://forsaken-hamburger.info/"}, {"id": "", "created_at": "2024-12-08T18:31:28.967Z", "modified_at": "2025-08-25T12:12:46.370Z", "trial_interval": "week", "trial_interval_count": 958373, "metadata": {"key": 269522}, "payment_processor": "stripe", "client_secret": "", "success_url": "https://wretched-peony.com/", "return_url": "https://tidy-reorganisation.org", "label": "", "allow_discount_codes": false, "require_billing_address": false, "discount_id": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "products": [{"metadata": {"key": false}, "id": "", "created_at": "2025-06-23T06:29:06.861Z", "modified_at": "2024-05-30T08:30:33.019Z", "trial_interval": "year", "trial_interval_count": 470214, "name": "", "description": "partially yellow gadzooks gleefully reassuringly qua around", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 438333, "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2025-07-07T18:45:01.201Z", "modified_at": "2023-05-16T12:45:34.730Z", "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}, {"created_at": "2023-04-05T16:33:44.616Z", "modified_at": "2023-12-19T09:15:06.533Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "inclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 363007, "legacy": true}], "benefits": [{"id": "", "created_at": "2025-01-11T23:38:31.265Z", "modified_at": "2023-05-01T01:24:54.811Z", "type": "downloadables", "description": "gosh french or slow bin competent tuba follower oof", "selectable": false, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-01-11T23:38:31.265Z", "modified_at": "2023-05-01T01:24:54.811Z", "type": "downloadables", "description": "gosh french or slow bin competent tuba follower oof", "selectable": false, "deletable": false, "organization_id": ""}, {"id": "", "created_at": "2025-01-11T23:38:31.265Z", "modified_at": "2023-05-01T01:24:54.811Z", "type": "downloadables", "description": "gosh french or slow bin competent tuba follower oof", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Library", "mime_type": "", "size": 397996, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-12-04T19:29:48.554Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-11-06T19:24:06.160Z", "size_readable": "", "public_url": "https://pitiful-flint.org"}, {"id": "", "organization_id": "", "name": "", "path": "/Library", "mime_type": "", "size": 397996, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-12-04T19:29:48.554Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2023-11-06T19:24:06.160Z", "size_readable": "", "public_url": "https://pitiful-flint.org"}]}], "discount": {"duration": "once", "duration_in_months": 354366, "type": "fixed", "basis_points": 140653, "created_at": "2024-08-19T15:49:46.374Z", "modified_at": "2024-11-08T09:13:07.988Z", "id": "", "metadata": {"key": 6965.21, "key1": 727000}, "name": "", "code": "", "starts_at": "2023-08-16T05:03:04.814Z", "ends_at": "2023-11-17T21:19:16.987Z", "max_redemptions": 65553, "redemptions_count": 331792, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "url": "https://forsaken-hamburger.info/"}], "pagination": {"total_count": 226341, "max_page": 804607}} "422": application/json: {} checkout-links:create: @@ -2940,7 +2958,7 @@ examples: application/json: {} responses: "200": - application/json: {"id": "", "created_at": "2024-02-14T03:05:16.462Z", "modified_at": "2023-10-02T17:43:12.732Z", "trial_interval": "year", "trial_interval_count": 763251, "metadata": {"key": 634930, "key1": 386368, "key2": 65111}, "payment_processor": "stripe", "client_secret": "", "success_url": null, "return_url": "https://extroverted-role.info", "label": "", "allow_discount_codes": false, "require_billing_address": true, "discount_id": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "products": [{"metadata": {"key": true}, "id": "", "created_at": "2025-10-17T09:34:18.549Z", "modified_at": "2023-05-08T01:48:20.829Z", "trial_interval": "month", "trial_interval_count": 386368, "name": "", "description": "gloat quadruple baggy wealthy definitive gummy", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 758989, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2023-10-02T17:43:12.732Z", "modified_at": "2024-03-22T06:34:43.285Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}, {"created_at": "2023-03-13T08:40:55.883Z", "modified_at": null, "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 250061, "legacy": true}], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/sys", "mime_type": "", "size": 93657, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-03-07T04:45:04.362Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-05-27T13:57:42.899Z", "size_readable": "", "public_url": "https://thorny-underneath.net/"}]}], "discount": {"duration": "once", "duration_in_months": 714829, "type": "fixed", "basis_points": 328433, "created_at": "2024-10-09T01:37:50.990Z", "modified_at": "2024-09-18T07:54:19.084Z", "id": "", "metadata": {"key": true, "key1": 836096}, "name": "", "code": "", "starts_at": "2023-07-16T07:36:44.270Z", "ends_at": "2024-02-21T08:23:11.430Z", "max_redemptions": 998703, "redemptions_count": 730226, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "url": "https://empty-importance.org"} + application/json: {"id": "", "created_at": "2024-02-14T03:05:16.462Z", "modified_at": "2023-10-02T17:43:12.732Z", "trial_interval": "year", "trial_interval_count": 763251, "metadata": {"key": 634930, "key1": 386368, "key2": 65111}, "payment_processor": "stripe", "client_secret": "", "success_url": null, "return_url": "https://extroverted-role.info", "label": "", "allow_discount_codes": false, "require_billing_address": true, "discount_id": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "products": [{"metadata": {"key": true}, "id": "", "created_at": "2025-10-17T09:34:18.549Z", "modified_at": "2023-05-08T01:48:20.829Z", "trial_interval": "month", "trial_interval_count": 386368, "name": "", "description": "gloat quadruple baggy wealthy definitive gummy", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 758989, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2023-10-02T17:43:12.732Z", "modified_at": "2024-03-22T06:34:43.285Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}, {"created_at": "2023-03-13T08:40:55.883Z", "modified_at": null, "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 250061, "legacy": true}], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/sys", "mime_type": "", "size": 93657, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2024-03-07T04:45:04.362Z", "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-05-27T13:57:42.899Z", "size_readable": "", "public_url": "https://thorny-underneath.net/"}]}], "discount": {"duration": "once", "duration_in_months": 714829, "type": "fixed", "basis_points": 328433, "created_at": "2024-10-09T01:37:50.990Z", "modified_at": "2024-09-18T07:54:19.084Z", "id": "", "metadata": {"key": true, "key1": 836096}, "name": "", "code": "", "starts_at": "2023-07-16T07:36:44.270Z", "ends_at": "2024-02-21T08:23:11.430Z", "max_redemptions": 998703, "redemptions_count": 730226, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "url": "https://empty-importance.org"} "404": application/json: {"error": "ResourceNotFound", "detail": ""} "422": @@ -3413,7 +3431,7 @@ examples: id: "" responses: "200": - application/json: {"id": "", "created_at": "2025-11-07T01:29:33.239Z", "modified_at": "2025-10-01T14:10:31.444Z", "status": "partially_refunded", "paid": true, "subtotal_amount": 10000, "discount_amount": 1000, "net_amount": 9000, "tax_amount": 720, "total_amount": 9720, "applied_balance_amount": 0, "due_amount": 0, "refunded_amount": 0, "refunded_tax_amount": 0, "currency": "usd", "billing_reason": "subscription_cycle", "billing_name": "", "billing_address": {"country": "US"}, "invoice_number": "", "is_invoice_generated": true, "customer_id": "", "product_id": "", "discount_id": "", "subscription_id": "", "checkout_id": "", "product": {"id": "", "created_at": "2023-11-19T04:53:34.522Z", "modified_at": "2025-11-25T20:27:43.607Z", "trial_interval": "week", "trial_interval_count": 836532, "name": "", "description": "too jubilantly empty meh", "visibility": "public", "recurring_interval": "month", "recurring_interval_count": 460383, "is_recurring": false, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2025-10-01T14:10:31.444Z", "modified_at": "2025-11-12T18:03:36.492Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 953506, "legacy": true}, {"created_at": "2025-11-13T23:04:52.208Z", "modified_at": "2023-07-18T15:45:42.662Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}], "benefits": [{"id": "", "created_at": "2025-07-23T03:55:01.103Z", "modified_at": "2025-05-14T03:22:06.100Z", "type": "meter_credit", "description": "ah coagulate not thankfully buzzing boohoo mask vulgarise far-off drat", "selectable": true, "deletable": true, "organization_id": ""}, {"id": "", "created_at": "2025-07-23T03:55:01.103Z", "modified_at": "2025-05-14T03:22:06.100Z", "type": "meter_credit", "description": "ah coagulate not thankfully buzzing boohoo mask vulgarise far-off drat", "selectable": true, "deletable": true, "organization_id": ""}, {"id": "", "created_at": "2025-07-23T03:55:01.103Z", "modified_at": "2025-05-14T03:22:06.100Z", "type": "meter_credit", "description": "ah coagulate not thankfully buzzing boohoo mask vulgarise far-off drat", "selectable": true, "deletable": true, "organization_id": ""}], "medias": [], "organization": {"created_at": "2023-07-27T19:30:57.624Z", "modified_at": "2025-02-13T12:23:44.948Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://hot-amendment.biz/", "proration_behavior": "prorate", "allow_customer_updates": false, "customer_portal_settings": {"usage": {"show": false}, "subscription": {"update_seats": false, "update_plan": true}}}}, "subscription": {"created_at": "2025-03-12T22:14:21.224Z", "modified_at": "2024-03-29T21:03:44.806Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "year", "recurring_interval_count": 916598, "status": "canceled", "current_period_start": "2023-10-08T20:14:11.453Z", "current_period_end": "2023-01-11T05:31:47.928Z", "trial_start": "2025-01-24T05:08:03.541Z", "trial_end": null, "cancel_at_period_end": true, "canceled_at": "2024-11-02T16:16:11.516Z", "started_at": "2024-04-10T15:06:14.767Z", "ends_at": "2023-08-09T06:47:34.634Z", "ended_at": "2023-05-14T07:05:36.107Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "too_expensive", "customer_cancellation_comment": ""}, "items": [{"created_at": "2023-03-15T16:46:25.288Z", "modified_at": "2023-06-13T07:31:24.272Z", "id": "", "label": "", "amount": 846674, "tax_amount": 465593, "proration": true, "product_price_id": ""}, {"created_at": "2023-03-15T16:46:25.288Z", "modified_at": "2023-06-13T07:31:24.272Z", "id": "", "label": "", "amount": 846674, "tax_amount": 465593, "proration": true, "product_price_id": ""}], "description": "Pro Plan"} + application/json: {"id": "", "created_at": "2025-11-07T01:29:33.239Z", "modified_at": "2025-10-01T14:10:31.444Z", "status": "partially_refunded", "paid": true, "subtotal_amount": 10000, "discount_amount": 1000, "net_amount": 9000, "tax_amount": 720, "total_amount": 9720, "applied_balance_amount": 0, "due_amount": 0, "refunded_amount": 0, "refunded_tax_amount": 0, "currency": "usd", "billing_reason": "subscription_cycle", "billing_name": "", "billing_address": {"country": "US"}, "invoice_number": "", "is_invoice_generated": true, "customer_id": "", "product_id": "", "discount_id": "", "subscription_id": "", "checkout_id": "", "product": {"id": "", "created_at": "2023-11-19T04:53:34.522Z", "modified_at": "2025-11-25T20:27:43.607Z", "trial_interval": "week", "trial_interval_count": 836532, "name": "", "description": "too jubilantly empty meh", "visibility": "public", "recurring_interval": "month", "recurring_interval_count": 460383, "is_recurring": false, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2025-10-01T14:10:31.444Z", "modified_at": "2025-11-12T18:03:36.492Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 953506, "legacy": true}, {"created_at": "2025-11-13T23:04:52.208Z", "modified_at": "2023-07-18T15:45:42.662Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}], "benefits": [{"id": "", "created_at": "2025-07-23T03:55:01.103Z", "modified_at": "2025-05-14T03:22:06.100Z", "type": "meter_credit", "description": "ah coagulate not thankfully buzzing boohoo mask vulgarise far-off drat", "selectable": true, "deletable": true, "organization_id": ""}, {"id": "", "created_at": "2025-07-23T03:55:01.103Z", "modified_at": "2025-05-14T03:22:06.100Z", "type": "meter_credit", "description": "ah coagulate not thankfully buzzing boohoo mask vulgarise far-off drat", "selectable": true, "deletable": true, "organization_id": ""}, {"id": "", "created_at": "2025-07-23T03:55:01.103Z", "modified_at": "2025-05-14T03:22:06.100Z", "type": "meter_credit", "description": "ah coagulate not thankfully buzzing boohoo mask vulgarise far-off drat", "selectable": true, "deletable": true, "organization_id": ""}], "medias": [], "organization": {"created_at": "2023-07-27T19:30:57.624Z", "modified_at": "2025-02-13T12:23:44.948Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://hot-amendment.biz/", "proration_behavior": "prorate", "allow_customer_updates": false, "customer_portal_settings": {"usage": {"show": false}, "subscription": {"update_seats": false, "update_plan": true}}}}, "subscription": {"created_at": "2025-03-12T22:14:21.224Z", "modified_at": "2024-03-29T21:03:44.806Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "year", "recurring_interval_count": 916598, "status": "canceled", "current_period_start": "2023-10-08T20:14:11.453Z", "current_period_end": "2023-01-11T05:31:47.928Z", "trial_start": "2025-01-24T05:08:03.541Z", "trial_end": null, "cancel_at_period_end": true, "canceled_at": "2024-11-02T16:16:11.516Z", "started_at": "2024-04-10T15:06:14.767Z", "ends_at": "2023-08-09T06:47:34.634Z", "ended_at": "2023-05-14T07:05:36.107Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "too_expensive", "customer_cancellation_comment": ""}, "items": [{"created_at": "2023-03-15T16:46:25.288Z", "modified_at": "2023-06-13T07:31:24.272Z", "id": "", "label": "", "amount": 846674, "tax_amount": 465593, "proration": true, "product_price_id": ""}, {"created_at": "2023-03-15T16:46:25.288Z", "modified_at": "2023-06-13T07:31:24.272Z", "id": "", "label": "", "amount": 846674, "tax_amount": 465593, "proration": true, "product_price_id": ""}], "description": "Pro Plan"} "404": application/json: {"error": "ResourceNotFound", "detail": ""} "422": @@ -3437,7 +3455,7 @@ examples: slug: "" responses: "200": - application/json: {"organization": {"created_at": "2025-06-05T07:04:36.562Z", "modified_at": "2024-07-19T19:10:17.295Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://doting-lifestyle.name/", "proration_behavior": "prorate", "allow_customer_updates": false, "customer_portal_settings": {"usage": {"show": false}, "subscription": {"update_seats": false, "update_plan": true}}}, "products": [{"id": "", "created_at": "2025-01-07T03:20:40.621Z", "modified_at": "2024-05-04T02:49:36.301Z", "trial_interval": "month", "trial_interval_count": 846548, "name": "", "description": "behold whereas once gleefully", "visibility": "public", "recurring_interval": null, "recurring_interval_count": 614752, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2024-07-19T19:10:17.295Z", "modified_at": "2023-10-04T14:51:08.320Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}, {"created_at": "2023-05-14T06:28:28.766Z", "modified_at": "2024-09-04T10:55:17.085Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 668979, "maximum_amount": 629088, "preset_amount": 687565, "legacy": true}, {"created_at": "2024-07-30T22:43:06.764Z", "modified_at": "2024-06-03T04:21:14.567Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 672573, "maximum_amount": 446275, "preset_amount": 235699, "legacy": true}], "benefits": [{"id": "", "created_at": "2023-06-10T21:02:03.324Z", "modified_at": "2023-10-23T22:10:37.289Z", "type": "meter_credit", "description": "oh dirty dirty ribbon rear yippee", "selectable": true, "deletable": true, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/usr/bin", "mime_type": "", "size": 187628, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": "2025-02-06T06:31:05.333Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-09-02T03:48:53.348Z", "size_readable": "", "public_url": "https://ragged-icebreaker.info/"}, {"id": "", "organization_id": "", "name": "", "path": "/usr/bin", "mime_type": "", "size": 187628, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": "2025-02-06T06:31:05.333Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-09-02T03:48:53.348Z", "size_readable": "", "public_url": "https://ragged-icebreaker.info/"}]}]} + application/json: {"organization": {"created_at": "2025-06-05T07:04:36.562Z", "modified_at": "2024-07-19T19:10:17.295Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://doting-lifestyle.name/", "proration_behavior": "prorate", "allow_customer_updates": false, "customer_portal_settings": {"usage": {"show": false}, "subscription": {"update_seats": false, "update_plan": true}}}, "products": [{"id": "", "created_at": "2025-01-07T03:20:40.621Z", "modified_at": "2024-05-04T02:49:36.301Z", "trial_interval": "month", "trial_interval_count": 846548, "name": "", "description": "behold whereas once gleefully", "visibility": "public", "recurring_interval": null, "recurring_interval_count": 614752, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2024-07-19T19:10:17.295Z", "modified_at": "2023-10-04T14:51:08.320Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "tax_behavior": "inclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}, {"created_at": "2023-05-14T06:28:28.766Z", "modified_at": "2024-09-04T10:55:17.085Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 668979, "maximum_amount": 629088, "preset_amount": 687565, "legacy": true}, {"created_at": "2024-07-30T22:43:06.764Z", "modified_at": "2024-06-03T04:21:14.567Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 672573, "maximum_amount": 446275, "preset_amount": 235699, "legacy": true}], "benefits": [{"id": "", "created_at": "2023-06-10T21:02:03.324Z", "modified_at": "2023-10-23T22:10:37.289Z", "type": "meter_credit", "description": "oh dirty dirty ribbon rear yippee", "selectable": true, "deletable": true, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/usr/bin", "mime_type": "", "size": 187628, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": "2025-02-06T06:31:05.333Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-09-02T03:48:53.348Z", "size_readable": "", "public_url": "https://ragged-icebreaker.info/"}, {"id": "", "organization_id": "", "name": "", "path": "/usr/bin", "mime_type": "", "size": 187628, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": "2025-02-06T06:31:05.333Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-09-02T03:48:53.348Z", "size_readable": "", "public_url": "https://ragged-icebreaker.info/"}]}]} "404": application/json: {"error": "ResourceNotFound", "detail": ""} "422": @@ -3451,7 +3469,7 @@ examples: limit: 10 responses: "200": - application/json: {"items": [{"created_at": "2023-01-03T00:35:12.592Z", "modified_at": "2023-02-04T21:40:45.220Z", "id": "", "amount": 678476, "currency": "Bahraini Dinar", "recurring_interval": "year", "recurring_interval_count": 180288, "status": "incomplete_expired", "current_period_start": "2025-01-25T11:12:42.694Z", "current_period_end": "2023-11-12T13:08:09.571Z", "trial_start": "2024-07-18T17:21:46.759Z", "trial_end": null, "cancel_at_period_end": true, "canceled_at": "2025-10-28T08:23:28.446Z", "started_at": "2024-01-04T03:39:38.578Z", "ends_at": "2024-09-23T17:15:31.139Z", "ended_at": "2024-04-21T13:12:27.764Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "other", "customer_cancellation_comment": "", "product": {"id": "", "created_at": "2024-06-21T23:07:53.931Z", "modified_at": "2024-07-17T01:06:55.024Z", "trial_interval": "day", "trial_interval_count": 96114, "name": "", "description": "an when upwardly", "visibility": "draft", "recurring_interval": "year", "recurring_interval_count": 1847, "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2023-01-03T00:35:12.592Z", "modified_at": "2023-02-04T21:40:45.220Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 944637, "legacy": true}], "benefits": [{"id": "", "created_at": "2024-12-28T06:49:52.968Z", "modified_at": "2025-12-13T05:34:39.641Z", "type": "discord", "description": "square back cuddly stack coop descent ick oil concrete give", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [], "organization": {"created_at": "2025-09-28T20:26:17.846Z", "modified_at": "2025-08-10T14:48:44.687Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://front-equal.com", "proration_behavior": "prorate", "allow_customer_updates": true, "customer_portal_settings": {"usage": {"show": false}, "subscription": {"update_seats": true, "update_plan": false}}}}, "prices": [{"created_at": "2024-04-28T23:59:29.324Z", "modified_at": "2023-08-04T11:59:00.224Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2025-05-06T00:46:00.044Z", "modified_at": "2023-10-31T12:02:35.613Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 746007, "legacy": true}], "meters": [{"created_at": "2025-05-02T07:49:21.214Z", "modified_at": "2023-02-10T02:24:08.500Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"created_at": "2025-02-01T06:30:45.854Z", "modified_at": "2025-08-13T09:16:38.863Z", "id": "", "name": ""}}, {"created_at": "2025-05-02T07:49:21.214Z", "modified_at": "2023-02-10T02:24:08.500Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"created_at": "2025-02-01T06:30:45.854Z", "modified_at": "2025-08-13T09:16:38.863Z", "id": "", "name": ""}}]}, {"created_at": "2023-01-03T00:35:12.592Z", "modified_at": "2023-02-04T21:40:45.220Z", "id": "", "amount": 678476, "currency": "Bahraini Dinar", "recurring_interval": "year", "recurring_interval_count": 580419, "status": "incomplete_expired", "current_period_start": "2025-01-25T11:12:42.694Z", "current_period_end": "2023-11-12T13:08:09.571Z", "trial_start": "2023-11-09T06:12:04.123Z", "trial_end": "2024-04-28T23:59:29.324Z", "cancel_at_period_end": true, "canceled_at": "2025-10-28T08:23:28.446Z", "started_at": "2024-01-04T03:39:38.578Z", "ends_at": "2024-09-23T17:15:31.139Z", "ended_at": "2024-04-21T13:12:27.764Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "other", "customer_cancellation_comment": "", "product": {"id": "", "created_at": "2024-06-21T23:07:53.931Z", "modified_at": "2024-07-17T01:06:55.024Z", "trial_interval": "day", "trial_interval_count": 941013, "name": "", "description": "an when upwardly", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": null, "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2024-01-12T09:39:36.733Z", "modified_at": "2023-09-02T17:20:24.135Z", "id": "", "source": "catalog", "amount_type": "metered_unit", "price_currency": "", "is_archived": false, "product_id": "", "unit_amount": "", "cap_amount": 655254, "meter_id": "", "meter": {"id": "", "name": ""}}], "benefits": [{"id": "", "created_at": "2024-12-28T06:49:52.968Z", "modified_at": "2025-12-13T05:34:39.641Z", "type": "discord", "description": "square back cuddly stack coop descent ick oil concrete give", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [], "organization": {"created_at": "2025-09-28T20:26:17.846Z", "modified_at": "2025-08-10T14:48:44.687Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://front-equal.com", "proration_behavior": "prorate", "allow_customer_updates": true, "customer_portal_settings": {"usage": {"show": false}, "subscription": {"update_seats": true, "update_plan": false}}}}, "prices": [{"created_at": "2023-08-23T16:58:58.285Z", "modified_at": "2023-06-20T17:27:13.322Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 850254, "legacy": true}, {"created_at": "2024-10-04T17:29:24.326Z", "modified_at": "2024-12-24T08:26:33.925Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 886852, "maximum_amount": 660944, "preset_amount": null, "legacy": true}], "meters": [{"created_at": "2025-05-02T07:49:21.214Z", "modified_at": "2023-02-10T02:24:08.500Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"created_at": "2025-02-01T06:30:45.854Z", "modified_at": "2025-08-13T09:16:38.863Z", "id": "", "name": ""}}, {"created_at": "2025-05-02T07:49:21.214Z", "modified_at": "2023-02-10T02:24:08.500Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"created_at": "2025-02-01T06:30:45.854Z", "modified_at": "2025-08-13T09:16:38.863Z", "id": "", "name": ""}}]}], "pagination": {"total_count": 843077, "max_page": 721699}} + application/json: {"items": [{"created_at": "2023-01-03T00:35:12.592Z", "modified_at": "2023-02-04T21:40:45.220Z", "id": "", "amount": 678476, "currency": "Bahraini Dinar", "recurring_interval": "year", "recurring_interval_count": 180288, "status": "incomplete_expired", "current_period_start": "2025-01-25T11:12:42.694Z", "current_period_end": "2023-11-12T13:08:09.571Z", "trial_start": "2024-07-18T17:21:46.759Z", "trial_end": null, "cancel_at_period_end": true, "canceled_at": "2025-10-28T08:23:28.446Z", "started_at": "2024-01-04T03:39:38.578Z", "ends_at": "2024-09-23T17:15:31.139Z", "ended_at": "2024-04-21T13:12:27.764Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "other", "customer_cancellation_comment": "", "product": {"id": "", "created_at": "2024-06-21T23:07:53.931Z", "modified_at": "2024-07-17T01:06:55.024Z", "trial_interval": "day", "trial_interval_count": 96114, "name": "", "description": "an when upwardly", "visibility": "draft", "recurring_interval": "year", "recurring_interval_count": 1847, "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2023-01-03T00:35:12.592Z", "modified_at": "2023-02-04T21:40:45.220Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 944637, "legacy": true}], "benefits": [{"id": "", "created_at": "2024-12-28T06:49:52.968Z", "modified_at": "2025-12-13T05:34:39.641Z", "type": "discord", "description": "square back cuddly stack coop descent ick oil concrete give", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [], "organization": {"created_at": "2025-09-28T20:26:17.846Z", "modified_at": "2025-08-10T14:48:44.687Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://front-equal.com", "proration_behavior": "prorate", "allow_customer_updates": true, "customer_portal_settings": {"usage": {"show": false}, "subscription": {"update_seats": true, "update_plan": false}}}}, "prices": [{"created_at": "2024-04-28T23:59:29.324Z", "modified_at": "2023-08-04T11:59:00.224Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "tax_behavior": null, "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2025-05-06T00:46:00.044Z", "modified_at": "2023-10-31T12:02:35.613Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 746007, "legacy": true}], "meters": [{"created_at": "2025-05-02T07:49:21.214Z", "modified_at": "2023-02-10T02:24:08.500Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"created_at": "2025-02-01T06:30:45.854Z", "modified_at": "2025-08-13T09:16:38.863Z", "id": "", "name": ""}}, {"created_at": "2025-05-02T07:49:21.214Z", "modified_at": "2023-02-10T02:24:08.500Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"created_at": "2025-02-01T06:30:45.854Z", "modified_at": "2025-08-13T09:16:38.863Z", "id": "", "name": ""}}], "pending_update": {"created_at": "2024-04-15T08:10:49.325Z", "modified_at": "2024-11-08T06:12:04.123Z", "id": "", "applies_at": "2026-01-25T11:12:42.694Z", "product_id": "", "seats": 196623}}, {"created_at": "2023-01-03T00:35:12.592Z", "modified_at": "2023-02-04T21:40:45.220Z", "id": "", "amount": 678476, "currency": "Bahraini Dinar", "recurring_interval": "year", "recurring_interval_count": 580419, "status": "incomplete_expired", "current_period_start": "2025-01-25T11:12:42.694Z", "current_period_end": "2023-11-12T13:08:09.571Z", "trial_start": "2023-11-09T06:12:04.123Z", "trial_end": "2024-04-28T23:59:29.324Z", "cancel_at_period_end": true, "canceled_at": "2025-10-28T08:23:28.446Z", "started_at": "2024-01-04T03:39:38.578Z", "ends_at": "2024-09-23T17:15:31.139Z", "ended_at": "2024-04-21T13:12:27.764Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "other", "customer_cancellation_comment": "", "product": {"id": "", "created_at": "2024-06-21T23:07:53.931Z", "modified_at": "2024-07-17T01:06:55.024Z", "trial_interval": "day", "trial_interval_count": 941013, "name": "", "description": "an when upwardly", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": null, "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2024-01-12T09:39:36.733Z", "modified_at": "2023-09-02T17:20:24.135Z", "id": "", "source": "catalog", "amount_type": "metered_unit", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "unit_amount": "", "cap_amount": 655254, "meter_id": "", "meter": {"id": "", "name": ""}}], "benefits": [{"id": "", "created_at": "2024-12-28T06:49:52.968Z", "modified_at": "2025-12-13T05:34:39.641Z", "type": "discord", "description": "square back cuddly stack coop descent ick oil concrete give", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [], "organization": {"created_at": "2025-09-28T20:26:17.846Z", "modified_at": "2025-08-10T14:48:44.687Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://front-equal.com", "proration_behavior": "prorate", "allow_customer_updates": true, "customer_portal_settings": {"usage": {"show": false}, "subscription": {"update_seats": true, "update_plan": false}}}}, "prices": [{"created_at": "2023-08-23T16:58:58.285Z", "modified_at": "2023-06-20T17:27:13.322Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "inclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 850254, "legacy": true}, {"created_at": "2024-10-04T17:29:24.326Z", "modified_at": "2024-12-24T08:26:33.925Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 886852, "maximum_amount": 660944, "preset_amount": null, "legacy": true}], "meters": [{"created_at": "2025-05-02T07:49:21.214Z", "modified_at": "2023-02-10T02:24:08.500Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"created_at": "2025-02-01T06:30:45.854Z", "modified_at": "2025-08-13T09:16:38.863Z", "id": "", "name": ""}}, {"created_at": "2025-05-02T07:49:21.214Z", "modified_at": "2023-02-10T02:24:08.500Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"created_at": "2025-02-01T06:30:45.854Z", "modified_at": "2025-08-13T09:16:38.863Z", "id": "", "name": ""}}], "pending_update": {"created_at": "2024-04-15T08:10:49.325Z", "modified_at": "2024-11-08T06:12:04.123Z", "id": "", "applies_at": "2026-01-25T11:12:42.694Z", "product_id": "", "seats": 196623}}], "pagination": {"total_count": 843077, "max_page": 721699}} "422": application/json: {} customer_portal:subscriptions:get: @@ -3461,7 +3479,7 @@ examples: id: "" responses: "200": - application/json: {"created_at": "2023-07-12T17:28:38.797Z", "modified_at": "2023-06-27T14:55:14.822Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 175847, "status": "past_due", "current_period_start": "2024-12-11T03:15:34.736Z", "current_period_end": "2025-04-27T11:18:42.852Z", "trial_start": "2025-06-29T15:49:22.120Z", "trial_end": "2024-11-13T19:04:25.284Z", "cancel_at_period_end": true, "canceled_at": "2024-01-29T06:39:34.276Z", "started_at": "2024-12-08T10:29:34.380Z", "ends_at": null, "ended_at": "2025-05-26T12:14:55.999Z", "customer_id": "", "product_id": "", "discount_id": null, "checkout_id": "", "customer_cancellation_reason": "low_quality", "customer_cancellation_comment": "", "product": {"id": "", "created_at": "2025-01-14T05:59:18.343Z", "modified_at": null, "trial_interval": "day", "trial_interval_count": 647934, "name": "", "description": "ew far-off whoever minus perfectly scared sunbathe uh-huh", "visibility": "draft", "recurring_interval": "year", "recurring_interval_count": 162063, "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [], "benefits": [{"id": "", "created_at": "2023-11-30T13:12:22.913Z", "modified_at": "2023-04-11T08:58:03.008Z", "type": "custom", "description": "as below frozen oily beyond pomelo exactly ugh violin whoa", "selectable": true, "deletable": true, "organization_id": ""}, {"id": "", "created_at": "2023-11-30T13:12:22.913Z", "modified_at": "2023-04-11T08:58:03.008Z", "type": "custom", "description": "as below frozen oily beyond pomelo exactly ugh violin whoa", "selectable": true, "deletable": true, "organization_id": ""}], "medias": [], "organization": {"created_at": "2023-01-09T04:27:19.997Z", "modified_at": "2025-06-19T15:44:52.777Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://alienated-ribbon.org", "proration_behavior": "invoice", "allow_customer_updates": false, "customer_portal_settings": {"usage": {"show": true}, "subscription": {"update_seats": false, "update_plan": true}}}}, "prices": [{"created_at": "2023-06-27T14:55:14.822Z", "modified_at": "2024-06-06T10:00:39.244Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2025-04-27T11:18:42.852Z", "modified_at": "2025-08-05T11:04:05.877Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 125071, "legacy": true}, {"created_at": "2024-08-10T11:08:56.200Z", "modified_at": "2023-09-21T23:53:38.929Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 684767, "maximum_amount": 130976, "preset_amount": null, "legacy": true}], "meters": []} + application/json: {"created_at": "2023-07-12T17:28:38.797Z", "modified_at": "2023-06-27T14:55:14.822Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 175847, "status": "past_due", "current_period_start": "2024-12-11T03:15:34.736Z", "current_period_end": "2025-04-27T11:18:42.852Z", "trial_start": "2025-06-29T15:49:22.120Z", "trial_end": "2024-11-13T19:04:25.284Z", "cancel_at_period_end": true, "canceled_at": "2024-01-29T06:39:34.276Z", "started_at": "2024-12-08T10:29:34.380Z", "ends_at": null, "ended_at": "2025-05-26T12:14:55.999Z", "customer_id": "", "product_id": "", "discount_id": null, "checkout_id": "", "customer_cancellation_reason": "low_quality", "customer_cancellation_comment": "", "product": {"id": "", "created_at": "2025-01-14T05:59:18.343Z", "modified_at": null, "trial_interval": "day", "trial_interval_count": 647934, "name": "", "description": "ew far-off whoever minus perfectly scared sunbathe uh-huh", "visibility": "draft", "recurring_interval": "year", "recurring_interval_count": 162063, "is_recurring": true, "is_archived": false, "organization_id": "", "prices": [], "benefits": [{"id": "", "created_at": "2023-11-30T13:12:22.913Z", "modified_at": "2023-04-11T08:58:03.008Z", "type": "custom", "description": "as below frozen oily beyond pomelo exactly ugh violin whoa", "selectable": true, "deletable": true, "organization_id": ""}, {"id": "", "created_at": "2023-11-30T13:12:22.913Z", "modified_at": "2023-04-11T08:58:03.008Z", "type": "custom", "description": "as below frozen oily beyond pomelo exactly ugh violin whoa", "selectable": true, "deletable": true, "organization_id": ""}], "medias": [], "organization": {"created_at": "2023-01-09T04:27:19.997Z", "modified_at": "2025-06-19T15:44:52.777Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://alienated-ribbon.org", "proration_behavior": "invoice", "allow_customer_updates": false, "customer_portal_settings": {"usage": {"show": true}, "subscription": {"update_seats": false, "update_plan": true}}}}, "prices": [{"created_at": "2023-06-27T14:55:14.822Z", "modified_at": "2024-06-06T10:00:39.244Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "tax_behavior": "exclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2025-04-27T11:18:42.852Z", "modified_at": "2025-08-05T11:04:05.877Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "tax_behavior": "inclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 125071, "legacy": true}, {"created_at": "2024-08-10T11:08:56.200Z", "modified_at": "2023-09-21T23:53:38.929Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 684767, "maximum_amount": 130976, "preset_amount": null, "legacy": true}], "meters": [], "pending_update": {"created_at": "2025-12-11T03:15:34.736Z", "modified_at": "2026-04-27T11:18:42.852Z", "id": "", "applies_at": "2024-09-10T20:47:05.678Z", "product_id": "", "seats": 540267}} "404": application/json: {"error": "ResourceNotFound", "detail": ""} "422": @@ -3475,13 +3493,15 @@ examples: application/json: {} responses: "200": - application/json: {"created_at": "2025-02-02T12:28:03.145Z", "modified_at": "2025-08-15T14:46:08.118Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 762480, "status": "active", "current_period_start": "2025-04-10T15:02:11.907Z", "current_period_end": "2026-04-15T16:15:33.406Z", "trial_start": "2025-02-02T12:28:03.145Z", "trial_end": "2025-08-15T14:46:08.118Z", "cancel_at_period_end": false, "canceled_at": "2024-03-16T11:27:11.204Z", "started_at": "2025-10-09T15:39:35.938Z", "ends_at": "2023-05-18T04:03:20.458Z", "ended_at": "2023-06-12T13:50:06.969Z", "customer_id": "", "product_id": "", "discount_id": null, "checkout_id": "", "customer_cancellation_reason": "customer_service", "customer_cancellation_comment": "", "product": {"id": "", "created_at": "2023-01-10T05:56:40.811Z", "modified_at": "2023-11-19T12:28:15.778Z", "trial_interval": "day", "trial_interval_count": 444374, "name": "", "description": "lest after until mantua colon dual tremendously well fairly", "visibility": "public", "recurring_interval": "month", "recurring_interval_count": 447532, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/home", "mime_type": "", "size": 323960, "storage_version": null, "checksum_etag": "", "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": null, "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-01-15T07:43:32.319Z", "size_readable": "", "public_url": "https://pitiful-cauliflower.com"}], "organization": {"created_at": "2024-01-05T08:15:54.903Z", "modified_at": "2023-05-06T23:49:18.498Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://taut-necklace.net/", "proration_behavior": "prorate", "allow_customer_updates": false, "customer_portal_settings": {"usage": {"show": true}, "subscription": {"update_seats": false, "update_plan": true}}}}, "prices": [{"created_at": "2024-05-05T11:52:58.589Z", "modified_at": "2023-07-27T15:38:08.165Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2025-02-06T13:35:55.076Z", "modified_at": "2025-11-12T16:20:13.096Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}], "meters": []} + application/json: {"created_at": "2025-02-02T12:28:03.145Z", "modified_at": "2025-08-15T14:46:08.118Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 762480, "status": "active", "current_period_start": "2025-04-10T15:02:11.907Z", "current_period_end": "2026-04-15T16:15:33.406Z", "trial_start": "2025-02-02T12:28:03.145Z", "trial_end": "2025-08-15T14:46:08.118Z", "cancel_at_period_end": false, "canceled_at": "2024-03-16T11:27:11.204Z", "started_at": "2025-10-09T15:39:35.938Z", "ends_at": "2023-05-18T04:03:20.458Z", "ended_at": "2023-06-12T13:50:06.969Z", "customer_id": "", "product_id": "", "discount_id": null, "checkout_id": "", "customer_cancellation_reason": "customer_service", "customer_cancellation_comment": "", "product": {"id": "", "created_at": "2023-01-10T05:56:40.811Z", "modified_at": "2023-11-19T12:28:15.778Z", "trial_interval": "day", "trial_interval_count": 444374, "name": "", "description": "lest after until mantua colon dual tremendously well fairly", "visibility": "public", "recurring_interval": "month", "recurring_interval_count": 447532, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/home", "mime_type": "", "size": 323960, "storage_version": null, "checksum_etag": "", "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": null, "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2024-01-15T07:43:32.319Z", "size_readable": "", "public_url": "https://pitiful-cauliflower.com"}], "organization": {"created_at": "2024-01-05T08:15:54.903Z", "modified_at": "2023-05-06T23:49:18.498Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://taut-necklace.net/", "proration_behavior": "prorate", "allow_customer_updates": false, "customer_portal_settings": {"usage": {"show": true}, "subscription": {"update_seats": false, "update_plan": true}}}}, "prices": [{"created_at": "2024-05-05T11:52:58.589Z", "modified_at": "2023-07-27T15:38:08.165Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "tax_behavior": "exclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2025-02-06T13:35:55.076Z", "modified_at": "2025-11-12T16:20:13.096Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}], "meters": [], "pending_update": {"created_at": "2024-07-03T22:27:22.248Z", "modified_at": "2025-05-02T00:48:47.943Z", "id": "", "applies_at": "2026-04-10T15:02:11.907Z", "product_id": null, "seats": 700335}} "403": application/json: {"error": "AlreadyCanceledSubscription", "detail": ""} "404": application/json: {"error": "ResourceNotFound", "detail": ""} "422": application/json: {} + "402": + application/json: {"error": "PaymentFailed", "detail": ""} customer_portal:subscriptions:cancel: speakeasy-default-customer-portal:subscriptions:cancel: parameters: @@ -3489,7 +3509,7 @@ examples: id: "" responses: "200": - application/json: {"created_at": "2023-03-14T00:34:28.136Z", "modified_at": "2025-03-22T12:28:05.757Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 65715, "status": "canceled", "current_period_start": "2024-04-07T12:57:17.210Z", "current_period_end": "2025-10-10T15:35:40.020Z", "trial_start": null, "trial_end": "2025-03-22T12:28:05.757Z", "cancel_at_period_end": true, "canceled_at": null, "started_at": "2023-04-12T10:07:43.423Z", "ends_at": "2025-04-12T20:30:15.370Z", "ended_at": "2023-12-08T22:19:01.857Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "too_complex", "customer_cancellation_comment": "", "product": {"id": "", "created_at": "2025-10-08T08:23:23.829Z", "modified_at": "2025-05-19T19:23:05.590Z", "trial_interval": "year", "trial_interval_count": 766852, "name": "", "description": "once yuck how inasmuch pish but more webbed", "visibility": "draft", "recurring_interval": "month", "recurring_interval_count": 740438, "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2025-03-22T12:28:05.757Z", "modified_at": "2025-04-16T15:43:34.874Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 948870, "maximum_amount": 383437, "preset_amount": null, "legacy": true}, {"created_at": "2025-09-28T07:43:04.431Z", "modified_at": "2023-06-14T21:44:38.981Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 920948, "maximum_amount": 928517, "preset_amount": 351570, "legacy": true}], "benefits": [{"id": "", "created_at": "2023-04-07T10:08:15.900Z", "modified_at": "2024-08-29T05:11:58.842Z", "type": "license_keys", "description": "when regarding woot mockingly um greatly sturdy incidentally accept save", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/usr", "mime_type": "", "size": 188787, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": null, "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-05-25T08:19:44.256Z", "size_readable": "", "public_url": "https://direct-recovery.info"}, {"id": "", "organization_id": "", "name": "", "path": "/usr", "mime_type": "", "size": 188787, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": null, "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-05-25T08:19:44.256Z", "size_readable": "", "public_url": "https://direct-recovery.info"}, {"id": "", "organization_id": "", "name": "", "path": "/usr", "mime_type": "", "size": 188787, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": null, "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-05-25T08:19:44.256Z", "size_readable": "", "public_url": "https://direct-recovery.info"}], "organization": {"created_at": "2023-03-23T07:37:57.258Z", "modified_at": "2024-09-08T02:10:05.056Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://urban-account.info/", "proration_behavior": "prorate", "allow_customer_updates": false, "customer_portal_settings": {"usage": {"show": false}, "subscription": {"update_seats": true, "update_plan": false}}}}, "prices": [{"created_at": "2025-11-16T11:22:00.864Z", "modified_at": "2025-05-23T05:24:01.371Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2024-08-30T20:56:44.463Z", "modified_at": null, "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}], "meters": [{"created_at": "2025-08-20T07:04:02.136Z", "modified_at": "2025-09-17T00:16:23.454Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"created_at": "2023-04-12T05:19:54.807Z", "modified_at": "2024-07-24T15:24:05.776Z", "id": "", "name": ""}}, {"created_at": "2025-08-20T07:04:02.136Z", "modified_at": "2025-09-17T00:16:23.454Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"created_at": "2023-04-12T05:19:54.807Z", "modified_at": "2024-07-24T15:24:05.776Z", "id": "", "name": ""}}]} + application/json: {"created_at": "2023-03-14T00:34:28.136Z", "modified_at": "2025-03-22T12:28:05.757Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 65715, "status": "canceled", "current_period_start": "2024-04-07T12:57:17.210Z", "current_period_end": "2025-10-10T15:35:40.020Z", "trial_start": null, "trial_end": "2025-03-22T12:28:05.757Z", "cancel_at_period_end": true, "canceled_at": null, "started_at": "2023-04-12T10:07:43.423Z", "ends_at": "2025-04-12T20:30:15.370Z", "ended_at": "2023-12-08T22:19:01.857Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "too_complex", "customer_cancellation_comment": "", "product": {"id": "", "created_at": "2025-10-08T08:23:23.829Z", "modified_at": "2025-05-19T19:23:05.590Z", "trial_interval": "year", "trial_interval_count": 766852, "name": "", "description": "once yuck how inasmuch pish but more webbed", "visibility": "draft", "recurring_interval": "month", "recurring_interval_count": 740438, "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2025-03-22T12:28:05.757Z", "modified_at": "2025-04-16T15:43:34.874Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": null, "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 948870, "maximum_amount": 383437, "preset_amount": null, "legacy": true}, {"created_at": "2025-09-28T07:43:04.431Z", "modified_at": "2023-06-14T21:44:38.981Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "exclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 920948, "maximum_amount": 928517, "preset_amount": 351570, "legacy": true}], "benefits": [{"id": "", "created_at": "2023-04-07T10:08:15.900Z", "modified_at": "2024-08-29T05:11:58.842Z", "type": "license_keys", "description": "when regarding woot mockingly um greatly sturdy incidentally accept save", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/usr", "mime_type": "", "size": 188787, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": null, "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-05-25T08:19:44.256Z", "size_readable": "", "public_url": "https://direct-recovery.info"}, {"id": "", "organization_id": "", "name": "", "path": "/usr", "mime_type": "", "size": 188787, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": null, "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-05-25T08:19:44.256Z", "size_readable": "", "public_url": "https://direct-recovery.info"}, {"id": "", "organization_id": "", "name": "", "path": "/usr", "mime_type": "", "size": 188787, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": null, "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-05-25T08:19:44.256Z", "size_readable": "", "public_url": "https://direct-recovery.info"}], "organization": {"created_at": "2023-03-23T07:37:57.258Z", "modified_at": "2024-09-08T02:10:05.056Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://urban-account.info/", "proration_behavior": "prorate", "allow_customer_updates": false, "customer_portal_settings": {"usage": {"show": false}, "subscription": {"update_seats": true, "update_plan": false}}}}, "prices": [{"created_at": "2025-11-16T11:22:00.864Z", "modified_at": "2025-05-23T05:24:01.371Z", "id": "", "source": "catalog", "amount_type": "free", "price_currency": "", "tax_behavior": "exclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "legacy": true}, {"created_at": "2024-08-30T20:56:44.463Z", "modified_at": null, "id": "", "source": "ad_hoc", "amount_type": "free", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "legacy": true}], "meters": [{"created_at": "2025-08-20T07:04:02.136Z", "modified_at": "2025-09-17T00:16:23.454Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"created_at": "2023-04-12T05:19:54.807Z", "modified_at": "2024-07-24T15:24:05.776Z", "id": "", "name": ""}}, {"created_at": "2025-08-20T07:04:02.136Z", "modified_at": "2025-09-17T00:16:23.454Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"created_at": "2023-04-12T05:19:54.807Z", "modified_at": "2024-07-24T15:24:05.776Z", "id": "", "name": ""}}], "pending_update": {"created_at": "2026-11-05T23:03:31.551Z", "modified_at": "2025-02-24T05:56:22.572Z", "id": "", "applies_at": "2024-02-16T10:11:42.223Z", "product_id": "", "seats": null}} "403": application/json: {"error": "AlreadyCanceledSubscription", "detail": ""} "404": @@ -3697,7 +3717,7 @@ examples: application/json: {"billing_address": {"country": "US"}} responses: "200": - application/json: {"id": "", "created_at": "2025-06-18T23:40:50.214Z", "modified_at": "2023-01-14T22:55:27.186Z", "status": "paid", "paid": true, "subtotal_amount": 10000, "discount_amount": 1000, "net_amount": 9000, "tax_amount": 720, "total_amount": 9720, "applied_balance_amount": 0, "due_amount": 0, "refunded_amount": 0, "refunded_tax_amount": 0, "currency": "usd", "billing_reason": "purchase", "billing_name": "", "billing_address": {"country": "US"}, "invoice_number": "", "is_invoice_generated": true, "customer_id": "", "product_id": "", "discount_id": "", "subscription_id": "", "checkout_id": "", "product": {"id": "", "created_at": "2024-02-03T21:16:03.609Z", "modified_at": null, "trial_interval": "year", "trial_interval_count": 947072, "name": "", "description": "gee present next brief till or", "visibility": "public", "recurring_interval": "year", "recurring_interval_count": 817410, "is_recurring": false, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2025-06-18T23:40:50.214Z", "modified_at": "2023-01-14T22:55:27.186Z", "id": "", "source": "ad_hoc", "amount_type": "metered_unit", "price_currency": "", "is_archived": true, "product_id": "", "unit_amount": "", "cap_amount": 459195, "meter_id": "", "meter": {"id": "", "name": ""}}], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/var/yp", "mime_type": "", "size": 245978, "storage_version": "", "checksum_etag": null, "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-09-02T01:31:39.639Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2024-04-27T06:51:48.796Z", "size_readable": "", "public_url": "https://monthly-concentration.com"}], "organization": {"created_at": "2024-05-09T04:05:31.223Z", "modified_at": "2025-07-23T21:23:51.247Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://finished-language.org/", "proration_behavior": "prorate", "allow_customer_updates": false, "customer_portal_settings": {"usage": {"show": false}, "subscription": {"update_seats": true, "update_plan": true}}}}, "subscription": {"created_at": "2025-08-10T03:04:21.532Z", "modified_at": "2024-08-23T05:41:16.519Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 821156, "status": "incomplete_expired", "current_period_start": "2024-07-27T23:16:23.597Z", "current_period_end": "2025-01-04T16:08:44.590Z", "trial_start": null, "trial_end": "2025-05-04T04:31:46.399Z", "cancel_at_period_end": true, "canceled_at": "2025-03-10T21:35:49.211Z", "started_at": "2023-10-24T00:47:38.683Z", "ends_at": "2024-08-10T21:46:10.059Z", "ended_at": "2023-10-02T07:02:51.789Z", "customer_id": "", "product_id": "", "discount_id": null, "checkout_id": "", "customer_cancellation_reason": "too_complex", "customer_cancellation_comment": ""}, "items": [{"created_at": "2024-10-06T01:05:33.969Z", "modified_at": "2024-09-29T23:53:44.892Z", "id": "", "label": "", "amount": 924277, "tax_amount": 651911, "proration": false, "product_price_id": ""}, {"created_at": "2024-10-06T01:05:33.969Z", "modified_at": "2024-09-29T23:53:44.892Z", "id": "", "label": "", "amount": 924277, "tax_amount": 651911, "proration": false, "product_price_id": ""}, {"created_at": "2024-10-06T01:05:33.969Z", "modified_at": "2024-09-29T23:53:44.892Z", "id": "", "label": "", "amount": 924277, "tax_amount": 651911, "proration": false, "product_price_id": ""}], "description": "Pro Plan"} + application/json: {"id": "", "created_at": "2025-06-18T23:40:50.214Z", "modified_at": "2023-01-14T22:55:27.186Z", "status": "paid", "paid": true, "subtotal_amount": 10000, "discount_amount": 1000, "net_amount": 9000, "tax_amount": 720, "total_amount": 9720, "applied_balance_amount": 0, "due_amount": 0, "refunded_amount": 0, "refunded_tax_amount": 0, "currency": "usd", "billing_reason": "purchase", "billing_name": "", "billing_address": {"country": "US"}, "invoice_number": "", "is_invoice_generated": true, "customer_id": "", "product_id": "", "discount_id": "", "subscription_id": "", "checkout_id": "", "product": {"id": "", "created_at": "2024-02-03T21:16:03.609Z", "modified_at": null, "trial_interval": "year", "trial_interval_count": 947072, "name": "", "description": "gee present next brief till or", "visibility": "public", "recurring_interval": "year", "recurring_interval_count": 817410, "is_recurring": false, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2025-06-18T23:40:50.214Z", "modified_at": "2023-01-14T22:55:27.186Z", "id": "", "source": "ad_hoc", "amount_type": "metered_unit", "price_currency": "", "tax_behavior": "exclusive", "is_archived": true, "product_id": "", "unit_amount": "", "cap_amount": 459195, "meter_id": "", "meter": {"id": "", "name": ""}}], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/var/yp", "mime_type": "", "size": 245978, "storage_version": "", "checksum_etag": null, "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": "2025-09-02T01:31:39.639Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2024-04-27T06:51:48.796Z", "size_readable": "", "public_url": "https://monthly-concentration.com"}], "organization": {"created_at": "2024-05-09T04:05:31.223Z", "modified_at": "2025-07-23T21:23:51.247Z", "id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "name": "", "slug": "", "avatar_url": "https://finished-language.org/", "proration_behavior": "prorate", "allow_customer_updates": false, "customer_portal_settings": {"usage": {"show": false}, "subscription": {"update_seats": true, "update_plan": true}}}}, "subscription": {"created_at": "2025-08-10T03:04:21.532Z", "modified_at": "2024-08-23T05:41:16.519Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 821156, "status": "incomplete_expired", "current_period_start": "2024-07-27T23:16:23.597Z", "current_period_end": "2025-01-04T16:08:44.590Z", "trial_start": null, "trial_end": "2025-05-04T04:31:46.399Z", "cancel_at_period_end": true, "canceled_at": "2025-03-10T21:35:49.211Z", "started_at": "2023-10-24T00:47:38.683Z", "ends_at": "2024-08-10T21:46:10.059Z", "ended_at": "2023-10-02T07:02:51.789Z", "customer_id": "", "product_id": "", "discount_id": null, "checkout_id": "", "customer_cancellation_reason": "too_complex", "customer_cancellation_comment": ""}, "items": [{"created_at": "2024-10-06T01:05:33.969Z", "modified_at": "2024-09-29T23:53:44.892Z", "id": "", "label": "", "amount": 924277, "tax_amount": 651911, "proration": false, "product_price_id": ""}, {"created_at": "2024-10-06T01:05:33.969Z", "modified_at": "2024-09-29T23:53:44.892Z", "id": "", "label": "", "amount": 924277, "tax_amount": 651911, "proration": false, "product_price_id": ""}, {"created_at": "2024-10-06T01:05:33.969Z", "modified_at": "2024-09-29T23:53:44.892Z", "id": "", "label": "", "amount": 924277, "tax_amount": 651911, "proration": false, "product_price_id": ""}], "description": "Pro Plan"} "404": application/json: {"error": "ResourceNotFound", "detail": ""} "422": @@ -4092,7 +4112,7 @@ examples: application/json: {"product_id": "d8dd2de1-21b7-4a41-8bc3-ce909c0cfe23", "customer_id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b"} responses: "201": - application/json: {"created_at": "2024-05-07T09:41:55.474Z", "modified_at": "2024-07-21T03:47:24.582Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 261853, "status": "incomplete", "current_period_start": "2025-05-30T22:14:44.546Z", "current_period_end": "2024-03-11T09:56:01.675Z", "trial_start": null, "trial_end": "2024-06-17T00:10:04.156Z", "cancel_at_period_end": true, "canceled_at": "2024-10-16T05:43:54.436Z", "started_at": "2023-08-13T14:15:39.992Z", "ends_at": "2023-02-26T21:36:33.823Z", "ended_at": null, "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "missing_features", "customer_cancellation_comment": "", "metadata": {}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2024-05-11T11:37:46.426Z", "modified_at": "2023-08-28T20:40:19.067Z", "metadata": {"key": ""}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2023-05-09T04:32:44.403Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2024-03-12T12:11:55.173Z", "modified_at": "2025-12-06T22:23:14.254Z", "trial_interval": "week", "trial_interval_count": 71746, "name": "", "description": "uneven lest shocked alongside", "visibility": "private", "recurring_interval": null, "recurring_interval_count": 106391, "is_recurring": false, "is_archived": true, "organization_id": "", "metadata": {}, "prices": [], "benefits": [{"id": "", "created_at": "2025-08-08T23:08:58.031Z", "modified_at": "2023-08-16T21:10:10.979Z", "type": "downloadables", "description": "consign ick circle", "selectable": false, "deletable": false, "organization_id": "", "metadata": {"key": ""}, "properties": {"archived": {"key": false, "key1": true, "key2": false}, "files": ["", "", ""]}}], "medias": [], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-12-25T03:27:59.537Z", "modified_at": "2025-03-22T12:04:54.293Z", "id": "", "metadata": {}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 335043, "required": true}]}, "discount": {"duration": "repeating", "duration_in_months": 470978, "type": "percentage", "basis_points": 1000, "created_at": "2023-01-02T12:02:59.434Z", "modified_at": "2024-12-18T23:17:27.575Z", "id": "", "metadata": {"key": 583422}, "name": "", "code": "", "starts_at": "2024-06-09T18:09:09.489Z", "ends_at": "2025-04-22T20:10:26.485Z", "max_redemptions": 345910, "redemptions_count": 235299, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [{"created_at": "2023-08-05T18:43:39.547Z", "modified_at": "2023-03-08T07:36:56.095Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "week", "price_amount": 984500, "legacy": true}], "meters": []} + application/json: {"created_at": "2024-05-07T09:41:55.474Z", "modified_at": "2024-07-21T03:47:24.582Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "month", "recurring_interval_count": 261853, "status": "incomplete", "current_period_start": "2025-05-30T22:14:44.546Z", "current_period_end": "2024-03-11T09:56:01.675Z", "trial_start": null, "trial_end": "2024-06-17T00:10:04.156Z", "cancel_at_period_end": true, "canceled_at": "2024-10-16T05:43:54.436Z", "started_at": "2023-08-13T14:15:39.992Z", "ends_at": "2023-02-26T21:36:33.823Z", "ended_at": null, "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "missing_features", "customer_cancellation_comment": "", "metadata": {}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2024-05-11T11:37:46.426Z", "modified_at": "2023-08-28T20:40:19.067Z", "metadata": {"key": ""}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2023-05-09T04:32:44.403Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2024-03-12T12:11:55.173Z", "modified_at": "2025-12-06T22:23:14.254Z", "trial_interval": "week", "trial_interval_count": 71746, "name": "", "description": "uneven lest shocked alongside", "visibility": "private", "recurring_interval": null, "recurring_interval_count": 106391, "is_recurring": false, "is_archived": true, "organization_id": "", "metadata": {}, "prices": [], "benefits": [{"id": "", "created_at": "2025-08-08T23:08:58.031Z", "modified_at": "2023-08-16T21:10:10.979Z", "type": "downloadables", "description": "consign ick circle", "selectable": false, "deletable": false, "organization_id": "", "metadata": {"key": ""}, "properties": {"archived": {"key": false, "key1": true, "key2": false}, "files": ["", "", ""]}}], "medias": [], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2024-12-25T03:27:59.537Z", "modified_at": "2025-03-22T12:04:54.293Z", "id": "", "metadata": {}, "type": "date", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 335043, "required": true}]}, "discount": {"duration": "repeating", "duration_in_months": 470978, "type": "percentage", "basis_points": 1000, "created_at": "2023-01-02T12:02:59.434Z", "modified_at": "2024-12-18T23:17:27.575Z", "id": "", "metadata": {"key": 583422}, "name": "", "code": "", "starts_at": "2024-06-09T18:09:09.489Z", "ends_at": "2025-04-22T20:10:26.485Z", "max_redemptions": 345910, "redemptions_count": 235299, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [{"created_at": "2023-08-05T18:43:39.547Z", "modified_at": "2023-03-08T07:36:56.095Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "inclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "week", "price_amount": 984500, "legacy": true}], "meters": [], "pending_update": {"created_at": "2025-07-21T03:47:24.582Z", "modified_at": "2024-10-13T23:47:40.655Z", "id": "", "applies_at": "2024-05-27T02:50:40.456Z", "product_id": "", "seats": 397275}} "422": application/json: {} customer_portal:wallets:list: @@ -4244,7 +4264,7 @@ examples: _endpointsubscription_past_due_post: speakeasy-default-endpointsubscription-past-due-post: requestBody: - application/json: {"type": "subscription.past_due", "timestamp": "2024-08-08T08:08:34.879Z", "data": {"created_at": "2024-08-04T16:17:07.577Z", "modified_at": "2024-12-31T22:57:08.265Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "week", "recurring_interval_count": 546644, "status": "past_due", "current_period_start": "2024-11-30T09:38:02.409Z", "current_period_end": "2025-05-17T12:45:53.215Z", "trial_start": "2025-08-11T03:24:52.872Z", "trial_end": "2025-11-23T15:14:32.091Z", "cancel_at_period_end": true, "canceled_at": "2025-11-23T20:41:28.274Z", "started_at": "2023-06-07T00:58:09.164Z", "ends_at": "2023-04-30T18:50:10.865Z", "ended_at": "2024-10-24T10:41:48.448Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "customer_service", "customer_cancellation_comment": "", "metadata": {"key": 88296}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2023-10-23T07:41:47.878Z", "modified_at": "2023-03-23T16:08:53.531Z", "metadata": {}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2024-03-24T05:44:38.605Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2024-12-22T12:33:51.204Z", "modified_at": "2025-12-27T02:54:47.268Z", "trial_interval": "year", "trial_interval_count": 142723, "name": "", "description": "within tomb spectacles um after when chunter inwardly brr", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 49747, "is_recurring": false, "is_archived": false, "organization_id": "", "metadata": {}, "prices": [], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/usr/bin", "mime_type": "", "size": 189018, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": "2024-10-16T11:09:40.675Z", "version": null, "service": "product_media", "is_uploaded": true, "created_at": "2023-04-25T02:01:36.979Z", "size_readable": "", "public_url": "https://exalted-unblinking.name"}], "attached_custom_fields": []}, "discount": {"duration": "forever", "type": "percentage", "basis_points": 1000, "created_at": "2024-09-15T03:00:42.261Z", "modified_at": "2023-01-21T01:11:57.675Z", "id": "", "metadata": {}, "name": "", "code": "", "starts_at": "2024-05-03T02:53:30.217Z", "ends_at": "2025-12-13T03:09:13.905Z", "max_redemptions": 205428, "redemptions_count": 683480, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [], "meters": []}} + application/json: {"type": "subscription.past_due", "timestamp": "2024-08-08T08:08:34.879Z", "data": {"created_at": "2024-08-04T16:17:07.577Z", "modified_at": "2024-12-31T22:57:08.265Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "week", "recurring_interval_count": 546644, "status": "past_due", "current_period_start": "2024-11-30T09:38:02.409Z", "current_period_end": "2025-05-17T12:45:53.215Z", "trial_start": "2025-08-11T03:24:52.872Z", "trial_end": "2025-11-23T15:14:32.091Z", "cancel_at_period_end": true, "canceled_at": "2025-11-23T20:41:28.274Z", "started_at": "2023-06-07T00:58:09.164Z", "ends_at": "2023-04-30T18:50:10.865Z", "ended_at": "2024-10-24T10:41:48.448Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "customer_service", "customer_cancellation_comment": "", "metadata": {"key": 88296}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2023-10-23T07:41:47.878Z", "modified_at": "2023-03-23T16:08:53.531Z", "metadata": {}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2024-03-24T05:44:38.605Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2024-12-22T12:33:51.204Z", "modified_at": "2025-12-27T02:54:47.268Z", "trial_interval": "year", "trial_interval_count": 142723, "name": "", "description": "within tomb spectacles um after when chunter inwardly brr", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 49747, "is_recurring": false, "is_archived": false, "organization_id": "", "metadata": {}, "prices": [], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/usr/bin", "mime_type": "", "size": 189018, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": "2024-10-16T11:09:40.675Z", "version": null, "service": "product_media", "is_uploaded": true, "created_at": "2023-04-25T02:01:36.979Z", "size_readable": "", "public_url": "https://exalted-unblinking.name"}], "attached_custom_fields": []}, "discount": {"duration": "forever", "type": "percentage", "basis_points": 1000, "created_at": "2024-09-15T03:00:42.261Z", "modified_at": "2023-01-21T01:11:57.675Z", "id": "", "metadata": {}, "name": "", "code": "", "starts_at": "2024-05-03T02:53:30.217Z", "ends_at": "2025-12-13T03:09:13.905Z", "max_redemptions": 205428, "redemptions_count": 683480, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [], "meters": [], "pending_update": {"created_at": "2025-08-04T16:17:07.577Z", "modified_at": "2025-12-31T22:57:08.265Z", "id": "", "applies_at": "2025-01-16T14:41:32.716Z", "product_id": "", "seats": 638140}}} responses: "200": application/json: "" @@ -4374,7 +4394,7 @@ examples: _endpointcheckout_expired_post: speakeasy-default-endpointcheckout-expired-post: requestBody: - application/json: {"type": "checkout.expired", "timestamp": "2025-07-24T10:11:01.088Z", "data": {"id": "", "created_at": "2024-05-04T16:36:16.430Z", "modified_at": "2025-07-14T11:38:07.998Z", "payment_processor": "stripe", "status": "open", "client_secret": "", "url": "https://husky-advertisement.biz/", "expires_at": "2026-08-22T23:38:29.173Z", "success_url": "https://wasteful-premeditation.org", "return_url": "https://torn-toothpick.name", "embed_origin": "", "amount": 104765, "discount_amount": 723749, "net_amount": 208098, "tax_amount": 740520, "total_amount": 729691, "currency": "Kwanza", "allow_trial": true, "active_trial_interval": "day", "active_trial_interval_count": 884805, "trial_end": "2026-12-24T16:37:35.525Z", "organization_id": "", "product_id": "", "product_price_id": "", "discount_id": "", "allow_discount_codes": false, "require_billing_address": false, "is_discount_applicable": true, "is_free_product_price": true, "is_payment_required": true, "is_payment_setup_required": false, "is_payment_form_required": true, "customer_id": "", "is_business_customer": false, "customer_name": "", "customer_email": "", "customer_ip_address": "", "customer_billing_name": "", "customer_billing_address": {"country": "US"}, "customer_tax_id": "", "payment_processor_metadata": {"key": ""}, "billing_address_fields": {"country": "disabled", "state": "disabled", "city": "required", "postal_code": "disabled", "line1": "required", "line2": "required"}, "trial_interval": "year", "trial_interval_count": 328311, "metadata": {}, "external_customer_id": "", "products": [{"id": "", "created_at": "2025-10-12T05:44:49.530Z", "modified_at": "2026-12-12T21:27:56.142Z", "trial_interval": "day", "trial_interval_count": 736956, "name": "", "description": "woot absent selfishly maestro frail unethically anguished solder", "visibility": "private", "recurring_interval": "month", "recurring_interval_count": 422566, "is_recurring": false, "is_archived": true, "organization_id": "", "prices": [], "benefits": [{"id": "", "created_at": "2024-02-20T20:34:14.140Z", "modified_at": null, "type": "meter_credit", "description": "yawn sharply inside ah lest who into", "selectable": false, "deletable": false, "organization_id": ""}], "medias": []}], "product": {"id": "", "created_at": "2025-07-25T20:35:56.555Z", "modified_at": "2025-07-29T02:50:59.712Z", "trial_interval": "week", "trial_interval_count": 272557, "name": "", "description": null, "visibility": "draft", "recurring_interval": "day", "recurring_interval_count": null, "is_recurring": false, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2026-12-31T01:02:14.398Z", "modified_at": "2025-02-10T09:37:50.330Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "day", "minimum_amount": 570455, "maximum_amount": 109251, "preset_amount": 453008, "legacy": true}], "benefits": [{"id": "", "created_at": "2024-02-20T20:34:14.140Z", "modified_at": null, "type": "meter_credit", "description": "yawn sharply inside ah lest who into", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Library", "mime_type": "", "size": 404380, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": null, "last_modified_at": "2026-07-14T04:50:58.042Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2026-09-12T12:00:29.248Z", "size_readable": "", "public_url": "https://nervous-mozzarella.net/"}]}, "product_price": {"created_at": "2025-04-26T17:11:01.549Z", "modified_at": "2024-01-18T01:05:34.563Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 993318, "maximum_amount": 699372, "preset_amount": 757943, "legacy": true}, "prices": {"key": []}, "discount": {"duration": "repeating", "type": "percentage", "basis_points": 1000, "id": "", "name": "", "code": ""}, "subscription_id": "", "attached_custom_fields": [], "customer_metadata": {}}} + application/json: {"type": "checkout.expired", "timestamp": "2025-07-24T10:11:01.088Z", "data": {"id": "", "created_at": "2024-05-04T16:36:16.430Z", "modified_at": "2025-07-14T11:38:07.998Z", "payment_processor": "stripe", "status": "open", "client_secret": "", "url": "https://husky-advertisement.biz/", "expires_at": "2026-08-22T23:38:29.173Z", "success_url": "https://wasteful-premeditation.org", "return_url": "https://torn-toothpick.name", "embed_origin": "", "amount": 104765, "discount_amount": 723749, "net_amount": 208098, "tax_amount": 740520, "total_amount": 729691, "currency": "Kwanza", "allow_trial": true, "active_trial_interval": "day", "active_trial_interval_count": 884805, "trial_end": "2026-12-24T16:37:35.525Z", "organization_id": "", "product_id": "", "product_price_id": "", "discount_id": "", "allow_discount_codes": false, "require_billing_address": false, "is_discount_applicable": true, "is_free_product_price": true, "is_payment_required": true, "is_payment_setup_required": false, "is_payment_form_required": true, "customer_id": "", "is_business_customer": false, "customer_name": "", "customer_email": "", "customer_ip_address": "", "customer_billing_name": "", "customer_billing_address": {"country": "US"}, "customer_tax_id": "", "payment_processor_metadata": {"key": ""}, "billing_address_fields": {"country": "disabled", "state": "disabled", "city": "required", "postal_code": "disabled", "line1": "required", "line2": "required"}, "trial_interval": "year", "trial_interval_count": 328311, "metadata": {}, "external_customer_id": "", "products": [{"id": "", "created_at": "2025-10-12T05:44:49.530Z", "modified_at": "2026-12-12T21:27:56.142Z", "trial_interval": "day", "trial_interval_count": 736956, "name": "", "description": "woot absent selfishly maestro frail unethically anguished solder", "visibility": "private", "recurring_interval": "month", "recurring_interval_count": 422566, "is_recurring": false, "is_archived": true, "organization_id": "", "prices": [], "benefits": [{"id": "", "created_at": "2024-02-20T20:34:14.140Z", "modified_at": null, "type": "meter_credit", "description": "yawn sharply inside ah lest who into", "selectable": false, "deletable": false, "organization_id": ""}], "medias": []}], "product": {"id": "", "created_at": "2025-07-25T20:35:56.555Z", "modified_at": "2025-07-29T02:50:59.712Z", "trial_interval": "week", "trial_interval_count": 272557, "name": "", "description": null, "visibility": "draft", "recurring_interval": "day", "recurring_interval_count": null, "is_recurring": false, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2026-12-31T01:02:14.398Z", "modified_at": "2025-02-10T09:37:50.330Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "day", "minimum_amount": 570455, "maximum_amount": 109251, "preset_amount": 453008, "legacy": true}], "benefits": [{"id": "", "created_at": "2024-02-20T20:34:14.140Z", "modified_at": null, "type": "meter_credit", "description": "yawn sharply inside ah lest who into", "selectable": false, "deletable": false, "organization_id": ""}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/Library", "mime_type": "", "size": 404380, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": null, "last_modified_at": "2026-07-14T04:50:58.042Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2026-09-12T12:00:29.248Z", "size_readable": "", "public_url": "https://nervous-mozzarella.net/"}]}, "product_price": {"created_at": "2025-04-26T17:11:01.549Z", "modified_at": "2024-01-18T01:05:34.563Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 993318, "maximum_amount": 699372, "preset_amount": 757943, "legacy": true}, "prices": {"key": []}, "discount": {"duration": "repeating", "type": "percentage", "basis_points": 1000, "id": "", "name": "", "code": ""}, "subscription_id": "", "attached_custom_fields": [], "customer_metadata": {}}} responses: "200": application/json: "" @@ -4409,7 +4429,7 @@ examples: application/json: {} examplesVersion: 1.0.2 generatedTests: {} -releaseNotes: "## Python SDK Changes Detected:\n* `polar._endpointcheckout_created_post()`: \n * `request.data.discount` **Changed** **Breaking** :warning:\n* `polar._endpointcheckout_updated_post()`: \n * `request.data.discount` **Changed** **Breaking** :warning:\n* `polar._endpointcheckout_expired_post()`: \n * `request.data.discount` **Changed** **Breaking** :warning:\n* `polar._endpointorder_created_post()`: \n * `request.data.discount` **Changed** **Breaking** :warning:\n* `polar._endpointorder_updated_post()`: \n * `request.data.discount` **Changed** **Breaking** :warning:\n* `polar._endpointorder_paid_post()`: \n * `request.data.discount` **Changed** **Breaking** :warning:\n* `polar._endpointorder_refunded_post()`: \n * `request.data.discount` **Changed** **Breaking** :warning:\n* `polar._endpointsubscription_created_post()`: \n * `request.data.discount` **Changed** **Breaking** :warning:\n* `polar._endpointsubscription_updated_post()`: \n * `request.data.discount` **Changed** **Breaking** :warning:\n* `polar._endpointsubscription_active_post()`: \n * `request.data.discount` **Changed** **Breaking** :warning:\n* `polar._endpointsubscription_canceled_post()`: \n * `request.data.discount` **Changed** **Breaking** :warning:\n* `polar._endpointsubscription_uncanceled_post()`: \n * `request.data.discount` **Changed** **Breaking** :warning:\n* `polar._endpointsubscription_revoked_post()`: \n * `request.data.discount` **Changed** **Breaking** :warning:\n* `polar._endpointsubscription_past_due_post()`: \n * `request.data.discount` **Changed** **Breaking** :warning:\n* `polar.events.get()`: `response.[system_event]` **Changed** **Breaking** :warning:\n* `polar.events.list()`: `response.[list_resource_event_].items.[].[system_event]` **Changed** **Breaking** :warning:\n* `polar.customers.update_external()`: \n * `request.customer_update_external_id.tax_id` **Changed** **Breaking** :warning:\n* `polar.customers.update()`: \n * `request.customer_update.tax_id` **Changed** **Breaking** :warning:\n* `polar.customers.create()`: \n * `request.tax_id` **Changed** **Breaking** :warning:\n* `polar.oauth2.token()`: `response` **Changed** **Breaking** :warning:\n* `polar.orders.list()`: `response.items.[].discount` **Changed**\n* `polar.checkout-links.create()`: `response.discount` **Changed**\n* `polar.orders.update()`: `response.discount` **Changed**\n* `polar.checkouts.list()`: `response.items.[].discount` **Changed**\n* `polar.checkouts.create()`: `response.discount` **Changed**\n* `polar.checkouts.get()`: `response.discount` **Changed**\n* `polar.checkouts.update()`: `response.discount` **Changed**\n* `polar.checkouts.client_get()`: `response.discount` **Changed**\n* `polar.checkouts.client_update()`: `response.discount` **Changed**\n* `polar.checkouts.client_confirm()`: `response.discount` **Changed**\n* `polar.checkout-links.list()`: `response.items.[].discount` **Changed**\n* `polar.orders.get()`: `response.discount` **Changed**\n* `polar.checkout-links.get()`: `response.discount` **Changed**\n* `polar.checkout-links.update()`: `response.discount` **Changed**\n* `polar.discounts.list()`: \n * `request.sorting` **Changed**\n * `response.items.[]` **Changed**\n* `polar.discounts.create()`: \n * `request` **Changed**\n * `response` **Changed**\n* `polar.discounts.get()`: `response` **Changed**\n* `polar.discounts.update()`: \n * `request.discount_update.amounts` **Added**\n * `response` **Changed**\n* `polar.subscriptions.update()`: `response.discount` **Changed**\n* `polar.subscriptions.revoke()`: `response.discount` **Changed**\n* `polar.subscriptions.get()`: `response.discount` **Changed**\n* `polar.subscriptions.create()`: `response.discount` **Changed**\n* `polar.subscriptions.list()`: `response.items.[].discount` **Changed**\n" +releaseNotes: "## Python SDK Changes Detected:\n* `polar._endpointcheckout_created_post()`: \n * `request.data` **Changed** **Breaking** :warning:\n* `polar._endpointcheckout_updated_post()`: \n * `request.data` **Changed** **Breaking** :warning:\n* `polar._endpointcheckout_expired_post()`: \n * `request.data` **Changed** **Breaking** :warning:\n* `polar._endpointsubscription_created_post()`: \n * `request.data` **Changed** **Breaking** :warning:\n* `polar._endpointsubscription_updated_post()`: \n * `request.data` **Changed** **Breaking** :warning:\n* `polar._endpointsubscription_active_post()`: \n * `request.data` **Changed** **Breaking** :warning:\n* `polar._endpointsubscription_canceled_post()`: \n * `request.data` **Changed** **Breaking** :warning:\n* `polar._endpointsubscription_uncanceled_post()`: \n * `request.data` **Changed** **Breaking** :warning:\n* `polar._endpointsubscription_revoked_post()`: \n * `request.data` **Changed** **Breaking** :warning:\n* `polar._endpointsubscription_past_due_post()`: \n * `request.data` **Changed** **Breaking** :warning:\n* `polar._endpointproduct_created_post()`: \n * `request.data.prices.[]` **Changed** **Breaking** :warning:\n* `polar._endpointproduct_updated_post()`: \n * `request.data.prices.[]` **Changed** **Breaking** :warning:\n* `polar._endpointorganization_updated_post()`: \n * `request.data` **Changed** **Breaking** :warning:\n* `polar.checkouts.client_confirm()`: `response` **Changed** **Breaking** :warning:\n* `polar.organizations.create()`: \n * `request` **Changed** **Breaking** :warning:\n * `response` **Changed**\n* `polar.checkouts.client_update()`: `response` **Changed** **Breaking** :warning:\n* `polar.organizations.update()`: \n * `request.organization_update` **Changed** **Breaking** :warning:\n * `response` **Changed**\n* `polar.checkouts.client_get()`: `response` **Changed** **Breaking** :warning:\n* `polar.checkouts.update()`: `response` **Changed** **Breaking** :warning:\n* `polar.checkouts.get()`: `response` **Changed** **Breaking** :warning:\n* `polar.checkouts.create()`: \n * `request.prices.{}.[]` **Changed**\n * `response` **Changed** **Breaking** :warning:\n* `polar.checkouts.list()`: `response.items.[]` **Changed** **Breaking** :warning:\n* `polar.products.get()`: `response.prices.[]` **Changed**\n* `polar.checkout-links.create()`: `response.products.[].prices.[]` **Changed**\n* `polar.products.list()`: `response.items.[].prices.[]` **Changed**\n* `polar.products.update()`: \n * `request.product_update.prices.[].[2]` **Changed**\n * `response.prices.[]` **Changed**\n* `polar.products.update_benefits()`: `response.prices.[]` **Changed**\n* `polar.subscriptions.update()`: \n * `response` **Changed**\n * `error.status[402]` **Added**\n* `polar.subscriptions.revoke()`: `response` **Changed**\n* `polar.subscriptions.get()`: `response` **Changed**\n* `polar.subscriptions.create()`: `response` **Changed**\n* `polar.subscriptions.list()`: `response.items.[]` **Changed**\n* `polar.organizations.get()`: `response` **Changed**\n* `polar.organizations.list()`: `response.items.[]` **Changed**\n* `polar.checkout-links.list()`: `response.items.[].products.[].prices.[]` **Changed**\n* `polar.products.create()`: \n * `request.[product_create_recurring].prices.[]` **Changed**\n * `response.prices.[]` **Changed**\n* `polar.checkout-links.get()`: `response.products.[].prices.[]` **Changed**\n* `polar.checkout-links.update()`: `response.products.[].prices.[]` **Changed**\n* `polar.members.list_members()`: `request.role` **Added**\n* `polar.customer_portal.seats.list_claimed_subscriptions()`: `response.items.[]` **Changed**\n* `polar.customer_portal.orders.list()`: `response.items.[].product.prices.[]` **Changed**\n* `polar.customer_portal.orders.get()`: `response.product.prices.[]` **Changed**\n* `polar.customer_portal.orders.update()`: `response.product.prices.[]` **Changed**\n* `polar.customer_portal.organizations.get()`: `response.products.[].prices.[]` **Changed**\n* `polar.customer_portal.subscriptions.list()`: `response.items.[]` **Changed**\n* `polar.customer_portal.subscriptions.get()`: `response` **Changed**\n* `polar.customer_portal.subscriptions.cancel()`: `response` **Changed**\n* `polar.customer_portal.subscriptions.update()`: \n * `response` **Changed**\n * `error.status[402]` **Added**\n" trackedFiles: .devcontainer/README.md: last_write_checksum: sha1:e2a191a1fa8ceb27387eb32eabf36f7ad16a532c @@ -4428,11 +4448,15 @@ trackedFiles: docs/models/activeuserbyevent.md: last_write_checksum: sha1:fc288fb93c2a8c2223d988eacdf88dd2e93ed415 docs/models/address.md: - last_write_checksum: sha1:5df2023ab71e94dbc07a285f9517c098f3426f7c + last_write_checksum: sha1:32d8a4f04a75436bda01b3c4c19371dbc58d93e8 + docs/models/addresscountryalpha2.md: + last_write_checksum: sha1:53651f6015d0413189822b9b2e1d434f59833199 docs/models/addressdict.md: last_write_checksum: sha1:498140cad526305fc068a313d7a195b3b077e222 docs/models/addressinput.md: - last_write_checksum: sha1:55b4d72a56c2b5ec289828e7370f738cf1e8c30f + last_write_checksum: sha1:d57f8d88be0daed671c1f917d177b184719f18a1 + docs/models/addressinputcountryalpha2input.md: + last_write_checksum: sha1:a898ed04bea58b2fd327212f324d9c5e9a4da37b docs/models/aggregation.md: last_write_checksum: sha1:2028ae03f5f49692de5c72ba3af5f626ba221653 docs/models/aggregationfunction.md: @@ -4732,7 +4756,7 @@ trackedFiles: docs/models/cashflow.md: last_write_checksum: sha1:1e9738516a979aa16a1dc2121b99d72055fc9abc docs/models/checkout.md: - last_write_checksum: sha1:6e21bb272d679925df3484cde3ba5259d148fb35 + last_write_checksum: sha1:1bb753eaf407a3dacc0118ca3bfcb27b9a1daafb docs/models/checkoutbillingaddressfields.md: last_write_checksum: sha1:4f9b44268a23c42b8af95d971f7642138d4542b1 docs/models/checkoutconfirmstripe.md: @@ -4822,9 +4846,9 @@ trackedFiles: docs/models/checkoutproductprices.md: last_write_checksum: sha1:3c5bf42bed9d76bd3f78cc17816e4ecd92de3f7d docs/models/checkoutpublic.md: - last_write_checksum: sha1:21841ff523f46e520053d4956c93c1e251b2602e + last_write_checksum: sha1:8ef847db5946a172f3f83311547328e75bf8b0a9 docs/models/checkoutpublicconfirmed.md: - last_write_checksum: sha1:1600e5357014b516e2649566c121f71d082e4ffa + last_write_checksum: sha1:61832cd3580dd11a2f1d81066bbffcf7670e4697 docs/models/checkoutpublicconfirmedcustomfielddata.md: last_write_checksum: sha1:b4a02ce44bdfe3eb45e9c99b0f1561e41028cdf2 docs/models/checkoutpublicconfirmeddiscount.md: @@ -4911,6 +4935,8 @@ trackedFiles: last_write_checksum: sha1:ea8fedbf2ece98006b8e856ebe45e5b6c34bd80d docs/models/countryalpha2.md: last_write_checksum: sha1:37cf156313127484678c145a1f34dbe29ff13dd5 + docs/models/countrycountryalpha2input.md: + last_write_checksum: sha1:76a52468b677dd42f53ba13792fba486d767db95 docs/models/cumulativecosts.md: last_write_checksum: sha1:e65f615229227a8bbec5121d2cb6888a59c7c580 docs/models/cumulativerevenue.md: @@ -5292,7 +5318,7 @@ trackedFiles: docs/models/customerstatetaxid.md: last_write_checksum: sha1:e0c84fc7dfb7b4185064a04c99c8e93126c5844d docs/models/customersubscription.md: - last_write_checksum: sha1:72ab147f923bfeac0dde7244fe23705f579c52af + last_write_checksum: sha1:0688cd6a63437aef874d5071714198d20f1e9d5e docs/models/customersubscriptioncancel.md: last_write_checksum: sha1:e77bd64f95923c220036361a527001b621869501 docs/models/customersubscriptionmeter.md: @@ -5652,11 +5678,13 @@ trackedFiles: docs/models/legacyrecurringproductprice.md: last_write_checksum: sha1:9d82f03d36e6bfbc8d648c7f92cadd6204230bc5 docs/models/legacyrecurringproductpricecustom.md: - last_write_checksum: sha1:b965442d643d1d25cdb7c7643e7b49e473078169 + last_write_checksum: sha1:fc9818e66c223e861ac51235e88e59777d887e09 docs/models/legacyrecurringproductpricefixed.md: - last_write_checksum: sha1:372ffb16c480eb80f82152d4d1827fb8b8ea7697 + last_write_checksum: sha1:52b6786864ccf57bc5c54b2c0970504474cb342c docs/models/legacyrecurringproductpricefree.md: - last_write_checksum: sha1:38381d73b6fab6331eb358152dd7ffb0d5880285 + last_write_checksum: sha1:886a91d69641d65ee66b0062d4aae7e23f07987b + docs/models/legalentity.md: + last_write_checksum: sha1:2c1299f2f0a37e6a6e4292c6710b57f1e51afd36 docs/models/licensekeyactivate.md: last_write_checksum: sha1:3e8a8683daaaf9323b5907ae0c4596d806643f62 docs/models/licensekeyactivateconditions.md: @@ -5784,7 +5812,7 @@ trackedFiles: docs/models/membersgetmemberrequest.md: last_write_checksum: sha1:dec2743653b66b14d36c7cf27b2642466043ef02 docs/models/memberslistmembersrequest.md: - last_write_checksum: sha1:dcec116e4fe2120168e3b35037b9080e9d50d27c + last_write_checksum: sha1:5dd0b507c4126e3ecf154618b426f67f0c85c078 docs/models/memberslistmembersresponse.md: last_write_checksum: sha1:41cffcad3ffa7900c31e7373d6a7ed0650ed844c docs/models/membersortproperty.md: @@ -5852,9 +5880,9 @@ trackedFiles: docs/models/metric.md: last_write_checksum: sha1:411b0713cbe399ca1e910583c851ecfc7de56e5d docs/models/metricperiod.md: - last_write_checksum: sha1:5d89629ef301116ea3309ace380c8e8164c88e18 + last_write_checksum: sha1:e9b897d2e4d1036b40d59ee871b64b3a9a7ec7a1 docs/models/metrics.md: - last_write_checksum: sha1:1c2abf4f090958ffc656a25478784eb84e2165a0 + last_write_checksum: sha1:413d4a63c6b5b4cb7d1cf5c0961310c1e004229f docs/models/metricsgetqueryparamcustomeridfilter.md: last_write_checksum: sha1:924adec655b715d269f3fdea5d5ce7ffca563385 docs/models/metricsgetqueryparamorganizationidfilter.md: @@ -5872,7 +5900,7 @@ trackedFiles: docs/models/metricsresponse.md: last_write_checksum: sha1:dfc86b2be35ea07eff8e0bd21b59806f76ab49e6 docs/models/metricstotals.md: - last_write_checksum: sha1:f94127df5fd2a5bb96ad15aa8319afb83b3eba54 + last_write_checksum: sha1:6fae100b68253e58c02f234855655965bbd2ff53 docs/models/metricstotalsactivesubscriptions.md: last_write_checksum: sha1:68eefc89f185cf9880c2d367931a7209848316bd docs/models/metricstotalsactiveuserbyevent.md: @@ -6084,7 +6112,7 @@ trackedFiles: docs/models/orderupdate.md: last_write_checksum: sha1:9933b2328bea2295842086aaea9aebf2909be782 docs/models/organization.md: - last_write_checksum: sha1:83254d4a028689b2cf3806fde59513d42cc7b5bb + last_write_checksum: sha1:4e9800befd91bc0d60a4c7ced9ba27e9daf7e9bb docs/models/organizationaccesstoken.md: last_write_checksum: sha1:9904324b19b1ebfd3118b57e94ef7f0137be3139 docs/models/organizationaccesstokencreate.md: @@ -6109,20 +6137,24 @@ trackedFiles: last_write_checksum: sha1:0a60b83dae5456f7ac858805abcb97d2b93c428d docs/models/organizationavatarfileread.md: last_write_checksum: sha1:542f57e33bff9a1350b01740081ed8156324e6bc + docs/models/organizationcompanylegalentityschema.md: + last_write_checksum: sha1:b8ef575e6f5bef416de4bceb6d5dfdcf5a476b5b docs/models/organizationcreate.md: - last_write_checksum: sha1:cac16c697c729f99d08a885f3787c2e8c6bb5803 + last_write_checksum: sha1:ea7a1851ca09211401b17ea01b9a810089136523 docs/models/organizationcustomeremailsettings.md: - last_write_checksum: sha1:409d0cb90e751adceacd1a29c87ed9c2fc85946a + last_write_checksum: sha1:6ab0e3789dee237e5708572bd838991ed496825d docs/models/organizationcustomerportalsettings.md: last_write_checksum: sha1:cee25f8da572e08579b7914973fdee2490b20f1d docs/models/organizationdetails.md: - last_write_checksum: sha1:4035786e9b89cd7ebdd8fa44feec92c38005738d + last_write_checksum: sha1:59784eef0c4fcb65f8c7006ffd0c3df8a7cfba0b docs/models/organizationfeaturesettings.md: last_write_checksum: sha1:deebd5f7da8e9ac5792ff09a59dea3b1ca15d948 docs/models/organizationid.md: last_write_checksum: sha1:5adf4fb1a723f361ac66da12542fedbe34fd9e5d docs/models/organizationidfilter.md: last_write_checksum: sha1:563cdbd6d0676af755e6049d3067242e0f816e53 + docs/models/organizationindividuallegalentityschema.md: + last_write_checksum: sha1:2ea97cdbe83c90aed9605835a6bc942ee2a67596 docs/models/organizationnotificationsettings.md: last_write_checksum: sha1:9dfa31a45e5c019bee16f7633b023be3524d8f42 docs/models/organizationsgetrequest.md: @@ -6144,7 +6176,7 @@ trackedFiles: docs/models/organizationsupdaterequest.md: last_write_checksum: sha1:82706bcd42b79c644b18f80c221a18df21a3ea9d docs/models/organizationupdate.md: - last_write_checksum: sha1:bdee2c797b19c852c6cd2697a73701caf244b542 + last_write_checksum: sha1:c13e180ecbb2d31f41a19e989d630bb8baf00487 docs/models/ownercreate.md: last_write_checksum: sha1:7cea3d4fa7ea00655a762c29cdaf13db9a55af12 docs/models/pagination.md: @@ -6155,6 +6187,8 @@ trackedFiles: last_write_checksum: sha1:7a77e5b6ecbe00b15806f0b1c60f0a59b84ac7d2 docs/models/paymenterror.md: last_write_checksum: sha1:63c7b81cc60e4716b0fb96b07a0adb70acdf9611 + docs/models/paymentfailed.md: + last_write_checksum: sha1:783089efceaa7e73bd26476925cd1693e7fa8ddf docs/models/paymentmethodcard.md: last_write_checksum: sha1:7b4db281156c56d62f5f40412d8e9b6007b27ac8 docs/models/paymentmethodcardmetadata.md: @@ -6185,12 +6219,14 @@ trackedFiles: last_write_checksum: sha1:25b182b092815e4b1230e5f9f3b4a55623641bbd docs/models/paymentstatus.md: last_write_checksum: sha1:65ec2fdffac467d08beee1dac0ad6edda52b81a6 + docs/models/pendingsubscriptionupdate.md: + last_write_checksum: sha1:05eaa3ecdfcb3783ca96b57462d7f0e6fe7e0f9d docs/models/permission.md: last_write_checksum: sha1:3609de98c77a1447fd2877e20a7367a4a9de4ee8 docs/models/portalauthenticateduser.md: last_write_checksum: sha1:e3b60b66a2ed740d87ebd4544d695a8ffba1d013 docs/models/presentmentcurrency.md: - last_write_checksum: sha1:03064b221c3ad6537186be666b91a90043730949 + last_write_checksum: sha1:61c1903683456b04a75a620d74606c590d5c6d48 docs/models/prices.md: last_write_checksum: sha1:81e08224e6fab8c1342367d2f4fc4006a4cd0d49 docs/models/product.md: @@ -6224,33 +6260,33 @@ trackedFiles: docs/models/productprice.md: last_write_checksum: sha1:54252dc04b8dce358f89a2a3bf8ec394d4d5499d docs/models/productpricecustom.md: - last_write_checksum: sha1:1f0ecbd7d59464a703ebd6f1ab2cfa9205cd35a7 + last_write_checksum: sha1:8093f9612d81eb6697675ba283a1e5607bdca558 docs/models/productpricecustomcreate.md: - last_write_checksum: sha1:08ecb78385f1c5051b5f4cec9906ca251c75b07e + last_write_checksum: sha1:319a1c32eb76688caf07da2d85d392edb785348c docs/models/productpricefixed.md: - last_write_checksum: sha1:874574a2d7dc7fcb66265166c2fab041588cfaae + last_write_checksum: sha1:0456129d409689286ceea9254e1f45498566e4da docs/models/productpricefixedcreate.md: - last_write_checksum: sha1:25de67e4535c1d6e26e071978485e2c0e6d6b906 + last_write_checksum: sha1:0f91758c422707a1e7808746ec9f7a663ba26e0c docs/models/productpricefree.md: - last_write_checksum: sha1:ccfb6859ce3de5b5d6da6a7ae042ce49b2169ee4 + last_write_checksum: sha1:5877a4eecbae4dc7951c1733461c1dab37fef3bb docs/models/productpricefreecreate.md: - last_write_checksum: sha1:c7a07e4bc9323dc2252f6832940bf8679d009d21 + last_write_checksum: sha1:9686ca2e4eda46a830f4160d2393b82bd761497f docs/models/productpricemeter.md: last_write_checksum: sha1:8f867e1d13bb83a6874be70853102b61a993973b docs/models/productpricemeteredunit.md: - last_write_checksum: sha1:475a2ccd710f212b44224d92780e6c50ab9a15d3 + last_write_checksum: sha1:86a9f783443b98322aa0d5feebe125452504044c docs/models/productpricemeteredunitcreate.md: - last_write_checksum: sha1:4325ade70004c94e28688bb699278f7430b7afe0 + last_write_checksum: sha1:d3c022951059e6ab9d7d79c6b6548c30087dd3fa docs/models/productpriceseatbased.md: - last_write_checksum: sha1:49bc7378d8b0a0e73d5bb98e0100dcfde2deb898 + last_write_checksum: sha1:7fe4791bf1a35df6cb302a59b2fcca7e7c794329 docs/models/productpriceseatbasedcreate.md: - last_write_checksum: sha1:2b5abfd2391ed2199242d26833866c76df5d5fda + last_write_checksum: sha1:d21fa29d8ec57b95fb6e8d093e07308e83222ef2 docs/models/productpriceseattier.md: last_write_checksum: sha1:03e0d4339c3283177211e8247132c1e95024cffb docs/models/productpriceseattiersinput.md: - last_write_checksum: sha1:cadbca817ff6cd5cfae8d0c83119007a0a670a2e + last_write_checksum: sha1:a7beaa82dcf38dc4e7d912951818b2447e51a7b7 docs/models/productpriceseattiersoutput.md: - last_write_checksum: sha1:e3b6241fd883fc36704d3dcf829b160fc02b861c + last_write_checksum: sha1:095f4e98e4a16bac8a7cf5a2d232918e904e6718 docs/models/productpricesource.md: last_write_checksum: sha1:3ee176c99c21161d0fa74d55eef526479af2cff6 docs/models/productsgetrequest.md: @@ -6372,7 +6408,7 @@ trackedFiles: docs/models/scope.md: last_write_checksum: sha1:98781293e9de67e2feb4011f6ce5dcc98ac19361 docs/models/seatassign.md: - last_write_checksum: sha1:3aa9acc7d18891406f3f52fa55b27cfd0c561713 + last_write_checksum: sha1:a20f544006c01b9883ccf9efb44a2407b64dc5d1 docs/models/seatclaim.md: last_write_checksum: sha1:5c0a6609867a86d6609ea984602d896be529b60f docs/models/seatclaiminfo.md: @@ -6381,6 +6417,8 @@ trackedFiles: last_write_checksum: sha1:f161766588d088c151fe9f76dc769423e0d6b7f2 docs/models/seatstatus.md: last_write_checksum: sha1:d666dd558cbee16fe7b4b2e4865cb62913386d31 + docs/models/seattiertype.md: + last_write_checksum: sha1:6b87079ee98935aa2d6d4dccf57ccfaf47bfee78 docs/models/security.md: last_write_checksum: sha1:f753dcacecd7ca563278a0049c19df233fc795a7 docs/models/sourcefilter.md: @@ -6390,7 +6428,7 @@ trackedFiles: docs/models/statusfilter.md: last_write_checksum: sha1:37f5fbdb09da95f228eb290d442b2bcb443e3992 docs/models/subscription.md: - last_write_checksum: sha1:85d0606b8c0ffc21248c1b0b597325ddcd283a0a + last_write_checksum: sha1:80555dc92f6a8ce97c748e70c133042e6401c5ef docs/models/subscriptionbillingperiodupdatedevent.md: last_write_checksum: sha1:cbb5ec95e9c17a9c6bce8d472de554baac345fe1 docs/models/subscriptionbillingperiodupdatedmetadata.md: @@ -6503,6 +6541,8 @@ trackedFiles: last_write_checksum: sha1:242623693cd6649aa665db76babcf7ff2531fd68 docs/models/systemevent.md: last_write_checksum: sha1:92f3c39717ccd791e918f9f0e3e6224e45e762bc + docs/models/taxbehavioroption.md: + last_write_checksum: sha1:7dd0e875d0dae49281b1320982ddbcd4294fc0ab docs/models/taxid.md: last_write_checksum: sha1:64208aafb3624e2eaf1d29edd54f62caf9bc2951 docs/models/taxidformat.md: @@ -6658,13 +6698,13 @@ trackedFiles: docs/sdks/checkoutlinks/README.md: last_write_checksum: sha1:8e6ba34a40b90e55dc5679a376e80665cebc34f0 docs/sdks/checkouts/README.md: - last_write_checksum: sha1:b5e608ce647fd40b0a8531f8f46ef61c3aa3b4b7 + last_write_checksum: sha1:53b563057d4190999d340a99e9ce01dea441ff57 docs/sdks/clients/README.md: last_write_checksum: sha1:6858b1e77eede8fe5d5dfe368a90ca228d2d3add docs/sdks/customermeters/README.md: last_write_checksum: sha1:b90c86939a9133539681534059241026b501c783 docs/sdks/customers/README.md: - last_write_checksum: sha1:c1a54c15276c6be923bd70b789197f2051de9042 + last_write_checksum: sha1:a7b97ac47d28045bd4d947c3c7ace5872402e227 docs/sdks/customerseats/README.md: last_write_checksum: sha1:7f63eb8dd09fcc98ffb4dc15cb4c9241bab5ae7d docs/sdks/customersessions/README.md: @@ -6688,7 +6728,7 @@ trackedFiles: docs/sdks/licensekeys/README.md: last_write_checksum: sha1:df9ec3e5784b8655379d3f0cceb52ea60dd72243 docs/sdks/members/README.md: - last_write_checksum: sha1:16dbef3afbb05a98b0ab8b934a30615ecffda282 + last_write_checksum: sha1:367e5d3c60293edbcec86a3b22edb28603f18dab docs/sdks/meters/README.md: last_write_checksum: sha1:780e81712d38d5a5bfbb6f72832b23a8bbed9bd9 docs/sdks/metricssdk/README.md: @@ -6696,7 +6736,7 @@ trackedFiles: docs/sdks/oauth2/README.md: last_write_checksum: sha1:41ab71747a1ea845eb6e342b3a827d347b0209d9 docs/sdks/orders/README.md: - last_write_checksum: sha1:a50204216512c4c8b41dcbd1a34219be2b7a1ce1 + last_write_checksum: sha1:ffb77f1a5836274870b5062f1eb2ea3f2d4fb3bb docs/sdks/organizationaccesstokens/README.md: last_write_checksum: sha1:05bb349d7b4ac8d0feda927af81a9a71de2e4684 docs/sdks/organizations/README.md: @@ -6708,17 +6748,17 @@ trackedFiles: docs/sdks/polarcustomermeters/README.md: last_write_checksum: sha1:3afd1422131745f9eeaf55cb8a28e386d3684d83 docs/sdks/polarcustomers/README.md: - last_write_checksum: sha1:be5b983c29f0ffa7bbf47f51b4c708d97c5b421d + last_write_checksum: sha1:4acf64f3dd8e5288ec8d864e3e14fe42c9f54ae2 docs/sdks/polarlicensekeys/README.md: last_write_checksum: sha1:01f6ad4f58453a9ef561beee742f8aebf20f42d8 docs/sdks/polarmembers/README.md: last_write_checksum: sha1:fee692177c33292dcd1d50cd81629bad7f5b8b3f docs/sdks/polarorders/README.md: - last_write_checksum: sha1:411e4861e94c69854934acb9483ee881c5cd415f + last_write_checksum: sha1:e29cffa2373e886f7a8b69386dd8a38de0d3fd43 docs/sdks/polarorganizations/README.md: last_write_checksum: sha1:a66f3e70e90bcafd1d61bed65d5dd4e98750fc3d docs/sdks/polarsubscriptions/README.md: - last_write_checksum: sha1:329244e775feb368a50808205f5aac9c1f6b6bd4 + last_write_checksum: sha1:7b5effd058f06ed0210c653add8d8d525578ab3f docs/sdks/products/README.md: last_write_checksum: sha1:37154bcd51efcd9dd0e172fd98af1ce158c9e140 docs/sdks/refunds/README.md: @@ -6726,7 +6766,7 @@ trackedFiles: docs/sdks/seats/README.md: last_write_checksum: sha1:4fababa9473ca4d33eb666d0a778aaca4d8334c1 docs/sdks/subscriptions/README.md: - last_write_checksum: sha1:220ba3c94ffccb8f76d096cbee75861fb01e47c4 + last_write_checksum: sha1:193f1bd2d433e9a12f00980b6498d1158e14eb6c docs/sdks/wallets/README.md: last_write_checksum: sha1:f8a655313c213e9c6a2900a2c12b499935f815bf docs/sdks/webhooks/README.md: @@ -6752,23 +6792,23 @@ trackedFiles: src/polar_sdk/_hooks/types.py: last_write_checksum: sha1:a218c66f3e2d1f1b9af54f270472b970b0cc1913 src/polar_sdk/_version.py: - last_write_checksum: sha1:ae19e1cd048068c8fc9762c1cd4a64389814f8be + last_write_checksum: sha1:a45c54df92495b013fa9a388230489daf2d54669 src/polar_sdk/basesdk.py: - last_write_checksum: sha1:3c3d1fd3866d63b09412c7ada0ed05b82b7513b2 + last_write_checksum: sha1:e17a40e5202e6e5974532ed42f39f6caf02a37d1 src/polar_sdk/benefit_grants.py: - last_write_checksum: sha1:606d04901fb78cbfc91574cf2c31aeeedb38d7e9 + last_write_checksum: sha1:7ad12e4f4bd830293bbe08cd980ee4ef91e6ab0b src/polar_sdk/benefits.py: - last_write_checksum: sha1:9af4617c07556fd69b6b21e69220e3f017fd6224 + last_write_checksum: sha1:a2135dafe0da862e227afd6c7f91f6a18da4fc41 src/polar_sdk/checkout_links.py: - last_write_checksum: sha1:0cab3c2e318738d73df4a012096553a5226b5a10 + last_write_checksum: sha1:e87f6097e32a64c5b2b17ee5db50e92dfa054b2a src/polar_sdk/checkouts.py: - last_write_checksum: sha1:ceb90b0fffcad78e5efcf2b5c03f263a081fa30d + last_write_checksum: sha1:4b8db5fa01a7dc6b975c44c57fb0a8f2c1c3684f src/polar_sdk/clients.py: last_write_checksum: sha1:0fcd13f6b2b1857b3f7fad45b7d2837cc4fc5b89 src/polar_sdk/custom_fields.py: - last_write_checksum: sha1:08484cffd37aa193b90554a06760efb88818029c + last_write_checksum: sha1:08aa3be6a5c8b91f20876f2a4baca40d60772e84 src/polar_sdk/customer_meters.py: - last_write_checksum: sha1:6037fed331b193502d17b0b0749af873b77485e3 + last_write_checksum: sha1:bca8288942b072ae633250449fccfc75edebc372 src/polar_sdk/customer_portal.py: last_write_checksum: sha1:c0a5dfdf0dc3b8caea86156f6f5685ab9b73964f src/polar_sdk/customer_seats.py: @@ -6778,37 +6818,37 @@ trackedFiles: src/polar_sdk/customer_sessions.py: last_write_checksum: sha1:9dcac4b97cff20d10c5f1d3ad480f5b9d799d7c5 src/polar_sdk/customers.py: - last_write_checksum: sha1:9bbc435dbf46ac75edf6f473f38045a78f54178a + last_write_checksum: sha1:87e651fca281f6b34a6d40c230548c06f62d2be2 src/polar_sdk/discounts.py: - last_write_checksum: sha1:42a28a0b0e6dd3fcf90d1b8f0ddc4928903fbd33 + last_write_checksum: sha1:4b4aab638350670cde3838c2a0d194b58a70ab03 src/polar_sdk/disputes.py: - last_write_checksum: sha1:7e5f3ce47301f16c31164f40f2ca7ed6acd52c1c + last_write_checksum: sha1:29b1c4582dfc65458c053c3cc202c86bd2a3466a src/polar_sdk/downloadables.py: - last_write_checksum: sha1:6fc6cfd93ae3683c60b8dfe9b61073ff9f73b8bd + last_write_checksum: sha1:df9ef74d28830e20a246454b3449094b98f5272e src/polar_sdk/event_types.py: - last_write_checksum: sha1:9112a9588e6d7723f6e9c331109f657e0d323527 + last_write_checksum: sha1:4c8bb20caf634277bf14acf23327b9f50536e523 src/polar_sdk/events.py: - last_write_checksum: sha1:14ee7cbbe6ec841e08355330ad246675cc8b6c76 + last_write_checksum: sha1:5b1e9b57cac03806b0c4fe3dda19f6de8c410a64 src/polar_sdk/files.py: - last_write_checksum: sha1:06f98681167bedcb61ab8f9831c0981cc2eb3c84 + last_write_checksum: sha1:77d97e0ab9738a40915191626779b2698d67d695 src/polar_sdk/httpclient.py: last_write_checksum: sha1:5e55338d6ee9f01ab648cad4380201a8a3da7dd7 src/polar_sdk/license_keys.py: - last_write_checksum: sha1:2146d2e8c447a1167b1adeaead0be9b4173919a8 + last_write_checksum: sha1:2da8abd3d041fd37eae14d138901ba2dbebb8eb3 src/polar_sdk/members.py: - last_write_checksum: sha1:79473b3aba18ae3e973a1944d7de05e64b8188c9 + last_write_checksum: sha1:5dece72810ce0a3836f028085f038266d91df4fc src/polar_sdk/meters.py: - last_write_checksum: sha1:e96cf02be2fe353afbe4db9e5278698832ac91d1 + last_write_checksum: sha1:ff196f0c7ab1edc307950ae436750825839ac187 src/polar_sdk/metrics_sdk.py: last_write_checksum: sha1:d35cb2e65dcc84d88d36a8f68ccf5a46868aff0f src/polar_sdk/models/__init__.py: - last_write_checksum: sha1:313a31022dd7f3efed060d4af62ddce69732d32c + last_write_checksum: sha1:a1a01ff27e662e39f0061f853e6132ec229a0eaa src/polar_sdk/models/address.py: - last_write_checksum: sha1:7d2c534dbbb5671f12809d7f78aa9d7173b6a145 + last_write_checksum: sha1:083edb7f045174ac1aea30545e9981c33f07d57d src/polar_sdk/models/addressdict.py: last_write_checksum: sha1:b15c2c7fb81a56fae0c0abc92a213504aae5a3ee src/polar_sdk/models/addressinput.py: - last_write_checksum: sha1:8b3669cedb5cf11a0c7fe8dcca46f1174e483c37 + last_write_checksum: sha1:4562611c576663f1e9906ae001c80bb1f8f47fdf src/polar_sdk/models/aggregationfunction.py: last_write_checksum: sha1:05923aee83110ef0a56e1cb2dc065c3614a9f369 src/polar_sdk/models/alreadyactivesubscriptionerror.py: @@ -7030,7 +7070,7 @@ trackedFiles: src/polar_sdk/models/cardpaymentmetadata.py: last_write_checksum: sha1:2fe22cf53af2f2fe9b5d9dbd4097c00838cf90d7 src/polar_sdk/models/checkout.py: - last_write_checksum: sha1:853cb87e4d5bc0e6fe9a6cc055ed843e747e1942 + last_write_checksum: sha1:1dbc425affa60422efa314c2d28f7cea26f755c1 src/polar_sdk/models/checkout_links_deleteop.py: last_write_checksum: sha1:0b6cad5372c170fb1431f4b1a2ed193dba02e9dc src/polar_sdk/models/checkout_links_getop.py: @@ -7080,9 +7120,9 @@ trackedFiles: src/polar_sdk/models/checkoutproduct.py: last_write_checksum: sha1:bc289d12dac265c70cbf4f26f9c3b890e127e6f6 src/polar_sdk/models/checkoutpublic.py: - last_write_checksum: sha1:8563e679172b13d46cd8aaf97c118c3582e09f29 + last_write_checksum: sha1:712b8f40c38d9b851ede2c74b49f3e265b5484c0 src/polar_sdk/models/checkoutpublicconfirmed.py: - last_write_checksum: sha1:e30f838208c907d511593e2352c7b37cc18761b6 + last_write_checksum: sha1:965b9917ca045cdd66c683cb8a2ff2213a4fb217 src/polar_sdk/models/checkouts_client_confirmop.py: last_write_checksum: sha1:43b8f70ae5ac54bbbfa26694c917b8b0359cefe5 src/polar_sdk/models/checkouts_client_getop.py: @@ -7370,7 +7410,7 @@ trackedFiles: src/polar_sdk/models/customerstatesubscriptionmeter.py: last_write_checksum: sha1:68b7f0d40544c69e4720cb950ed4167726757625 src/polar_sdk/models/customersubscription.py: - last_write_checksum: sha1:bee19a7aa6e735bcaf9f11f4c0fe8c293ba8dfde + last_write_checksum: sha1:014bbf96d19594571faa35d563993e478f5cc831 src/polar_sdk/models/customersubscriptioncancel.py: last_write_checksum: sha1:ebc12793a83e18b17e2647b91018d2f361842243 src/polar_sdk/models/customersubscriptionmeter.py: @@ -7598,11 +7638,11 @@ trackedFiles: src/polar_sdk/models/legacyrecurringproductprice.py: last_write_checksum: sha1:ffec681fbd5c09606933303539d942cb4a47af23 src/polar_sdk/models/legacyrecurringproductpricecustom.py: - last_write_checksum: sha1:630954304920eae6637386e97ec5718e54d58a09 + last_write_checksum: sha1:54299367b109823d400c74775b78b9fe3660e961 src/polar_sdk/models/legacyrecurringproductpricefixed.py: - last_write_checksum: sha1:a2c005d49def3e1e495c0428a605a3563b3790e2 + last_write_checksum: sha1:33b8e366d03dd12fdac176bc92c646e108cd18f6 src/polar_sdk/models/legacyrecurringproductpricefree.py: - last_write_checksum: sha1:8860b857800f91594c53953da309a79b9cab90f2 + last_write_checksum: sha1:31788434f154815c98e0874e57da6405bf42821b src/polar_sdk/models/license_keys_get_activationop.py: last_write_checksum: sha1:4421b41d10d32d4a1cdafc69e2aa11c2c068b03d src/polar_sdk/models/license_keys_getop.py: @@ -7712,7 +7752,7 @@ trackedFiles: src/polar_sdk/models/members_get_memberop.py: last_write_checksum: sha1:7a1b33eef42ad23eaf2b5f524e4baf616c0f44ae src/polar_sdk/models/members_list_membersop.py: - last_write_checksum: sha1:5f914125f81681fea69b01a4355129c657d8533e + last_write_checksum: sha1:1f7e158072976dd865365fff56f5316824bf9223 src/polar_sdk/models/members_update_memberop.py: last_write_checksum: sha1:7ebe88b82aedebef4167705d14f5e8a51873d0d5 src/polar_sdk/models/membersortproperty.py: @@ -7748,9 +7788,9 @@ trackedFiles: src/polar_sdk/models/metric.py: last_write_checksum: sha1:e3bff6cc55dc2c23b6119060ef82450a8f869b06 src/polar_sdk/models/metricperiod.py: - last_write_checksum: sha1:c05515aec24273baf48df56c33b27a5c55fe2391 + last_write_checksum: sha1:40f577284022e4336d433262faec85dc6111f8fa src/polar_sdk/models/metrics.py: - last_write_checksum: sha1:653c8bfcb7403959544de3f7ff0d093242dcac2c + last_write_checksum: sha1:73a2517d235861a74d85ee50d1ed7313779da2d3 src/polar_sdk/models/metrics_getop.py: last_write_checksum: sha1:1d7145472b4bc6b65625558ef0a4621e2142912c src/polar_sdk/models/metricsintervallimit.py: @@ -7762,7 +7802,7 @@ trackedFiles: src/polar_sdk/models/metricsresponse.py: last_write_checksum: sha1:e4ce63adb5ddc154bd65356519302e13ff4a2625 src/polar_sdk/models/metricstotals.py: - last_write_checksum: sha1:c61cec38d7a3a1f2b8953ea0f2468ec4a9957508 + last_write_checksum: sha1:40e0e4e9859b72343ea2b2eee94dbc62add96ee7 src/polar_sdk/models/metrictype.py: last_write_checksum: sha1:e741bf8b552aafd5b3cc9b3bbcb2d22c96f9503f src/polar_sdk/models/missinginvoicebillingdetails.py: @@ -7834,7 +7874,7 @@ trackedFiles: src/polar_sdk/models/orderupdate.py: last_write_checksum: sha1:89edd80c248803382ab77cfef04497d1d6f4dab1 src/polar_sdk/models/organization.py: - last_write_checksum: sha1:fccc5710def7f7b6616267f02837d7192b7d9e68 + last_write_checksum: sha1:cb7a02d7a3f46252c7e39c040741dd968300bb11 src/polar_sdk/models/organization_access_tokens_deleteop.py: last_write_checksum: sha1:d1a2e56defb6bb2b7036b7311b28a99174880b1d src/polar_sdk/models/organization_access_tokens_listop.py: @@ -7855,16 +7895,20 @@ trackedFiles: last_write_checksum: sha1:b7259ea58bda0b8385bf6916f03a90e8e1393096 src/polar_sdk/models/organizationavatarfileread.py: last_write_checksum: sha1:bcf88fcba96063cedb143d5eed2321ae07ea9e13 + src/polar_sdk/models/organizationcompanylegalentityschema.py: + last_write_checksum: sha1:1ef480d7d0ddf4a07efbca15fbf0c3cf71790b54 src/polar_sdk/models/organizationcreate.py: - last_write_checksum: sha1:c4fdee0c36fc4777bd3d1b1289b5d4765aaca576 + last_write_checksum: sha1:2db0fe2a557ec0bc8aac67e6a11b7580e1d8605d src/polar_sdk/models/organizationcustomeremailsettings.py: - last_write_checksum: sha1:8e89eadae01905ed9f9960f9d72145824a936049 + last_write_checksum: sha1:22d037fa5aa65cc2b5171d0da1588cd145a1bd16 src/polar_sdk/models/organizationcustomerportalsettings.py: last_write_checksum: sha1:4ba81b296790974393900cbc2aadf99f8c901fc8 src/polar_sdk/models/organizationdetails.py: - last_write_checksum: sha1:10204c8a1c69bcae61abd499fd64832cbb0c3dec + last_write_checksum: sha1:74233062d4ab6a42a6799705ac3cfd820ba3244c src/polar_sdk/models/organizationfeaturesettings.py: last_write_checksum: sha1:53e717110cdfbb8a4cf1c27cff963d16e84885c8 + src/polar_sdk/models/organizationindividuallegalentityschema.py: + last_write_checksum: sha1:33b021299f8a9ef86b315e3030acf6e34ccedeb4 src/polar_sdk/models/organizationnotificationsettings.py: last_write_checksum: sha1:d56d2a800ac2800e155ca918ff4e6765797ee3ed src/polar_sdk/models/organizations_getop.py: @@ -7884,7 +7928,7 @@ trackedFiles: src/polar_sdk/models/organizationsubscriptionsettings.py: last_write_checksum: sha1:73a282ee26583928dae0e91c03a6e9941be37a75 src/polar_sdk/models/organizationupdate.py: - last_write_checksum: sha1:061986b45879c208037ab56b0644d14ada0772ae + last_write_checksum: sha1:6c402c1339a3c3911ab3d6026a98e00bd8b6fa72 src/polar_sdk/models/ownercreate.py: last_write_checksum: sha1:3c81078036b943e2e2204ec43bcc38c77b173d89 src/polar_sdk/models/pagination.py: @@ -7895,6 +7939,8 @@ trackedFiles: last_write_checksum: sha1:fa33f08bd9d50268ed3a87e38589f625a4910e44 src/polar_sdk/models/paymenterror.py: last_write_checksum: sha1:3431d53c1df93442c33c2d8410b333daae4c70d8 + src/polar_sdk/models/paymentfailed.py: + last_write_checksum: sha1:49079a0a4a2b99f53218c86fac1413db1229228b src/polar_sdk/models/paymentmethodcard.py: last_write_checksum: sha1:a4ec4575c814e54f0b33fa464503434b2ff296d6 src/polar_sdk/models/paymentmethodcardmetadata.py: @@ -7915,12 +7961,14 @@ trackedFiles: last_write_checksum: sha1:2803a0c85f1046a5e19a3f7f136d789e5b0ca439 src/polar_sdk/models/paymentstatus.py: last_write_checksum: sha1:244c8b0d56fc98007d9b0a8d2a58b43367a2ad38 + src/polar_sdk/models/pendingsubscriptionupdate.py: + last_write_checksum: sha1:106e83d23e6f364912ad4a23c7ea5b21acf19b4a src/polar_sdk/models/polarerror.py: last_write_checksum: sha1:d09a746165d04c355e8bad3d060c49766ca58b32 src/polar_sdk/models/portalauthenticateduser.py: last_write_checksum: sha1:a1ba85446cad0ca3f68b5a9e865ceebea540fba7 src/polar_sdk/models/presentmentcurrency.py: - last_write_checksum: sha1:851f5d7153dd35efea723d13f86559874cdc7b60 + last_write_checksum: sha1:deb44d98b72ee085d67566f70d73c618ca6f748a src/polar_sdk/models/product.py: last_write_checksum: sha1:ef59d2a9fda758c49c4dad6be2571dd640a184ac src/polar_sdk/models/productbenefitsupdate.py: @@ -7940,33 +7988,33 @@ trackedFiles: src/polar_sdk/models/productprice.py: last_write_checksum: sha1:94940ba8feb6d3d69a0b63c7ecbd7602892c5de2 src/polar_sdk/models/productpricecustom.py: - last_write_checksum: sha1:37ec379bdf1d126b8583a6a716aa31d074105654 + last_write_checksum: sha1:d24aa930dd8b0d4dc088e9d4c7004d95529c7376 src/polar_sdk/models/productpricecustomcreate.py: - last_write_checksum: sha1:0c762bcf5c8bcf263071c727404f18702066a5f8 + last_write_checksum: sha1:76d5138b19b0fafdd6230de28837523dde7cf1d1 src/polar_sdk/models/productpricefixed.py: - last_write_checksum: sha1:15a119df79ef4d36d72c80f7e4a0f88d789f2263 + last_write_checksum: sha1:9b5e42ece47c918221067ce8ea86005edf364c93 src/polar_sdk/models/productpricefixedcreate.py: - last_write_checksum: sha1:68fbf7d9547b947ed814c90123f4ef234a9f815d + last_write_checksum: sha1:83c8f840c8143f939b957395b6b55b0a56ab5edb src/polar_sdk/models/productpricefree.py: - last_write_checksum: sha1:31f96a4b8cb16142dbe9a3417fd0f66248c994f8 + last_write_checksum: sha1:bfacb3a8115f8a96ed2adc4c4e6660abf99632fe src/polar_sdk/models/productpricefreecreate.py: - last_write_checksum: sha1:e7f4281d3b95ae61d5f5de06df7cfdf6137b34cb + last_write_checksum: sha1:502b04d4bc7b36fe8f6fc18e2db7dc9cac7ce397 src/polar_sdk/models/productpricemeter.py: last_write_checksum: sha1:5fbb6ea55768826cc63e705a5689f430e284d580 src/polar_sdk/models/productpricemeteredunit.py: - last_write_checksum: sha1:c2fa2c1a8f2e5ec9f6af7553bfb3a8c308bf458a + last_write_checksum: sha1:aa399b405edcd37795e7dd67df2506d97c98a902 src/polar_sdk/models/productpricemeteredunitcreate.py: - last_write_checksum: sha1:0bb8be1d513c5eb3f5d7dceecc41bd70d2d216c4 + last_write_checksum: sha1:16228fd6068b439928a01e6ca7166aa8f8c0caf7 src/polar_sdk/models/productpriceseatbased.py: - last_write_checksum: sha1:4c7711ccb6e4ca717f47969c4f78be9f2fd3acd8 + last_write_checksum: sha1:68ca1e70b19ac5fb199102732cacf01ac2c74d22 src/polar_sdk/models/productpriceseatbasedcreate.py: - last_write_checksum: sha1:4d57cecd66c89e5363d263e490c73cecb677f415 + last_write_checksum: sha1:65a654c39e4ef77f72299f113d6cb58697296dfd src/polar_sdk/models/productpriceseattier.py: last_write_checksum: sha1:10e8c0eb28ec1b941f438f684955762bec7903fd src/polar_sdk/models/productpriceseattiers_input.py: - last_write_checksum: sha1:5187ff879cd656a2859963f42a79aea4b25b44fa + last_write_checksum: sha1:3a35c1e6193b07c12064cb962150ae87603eb623 src/polar_sdk/models/productpriceseattiers_output.py: - last_write_checksum: sha1:37c166784e4556ad5e331e8a2c2ccdeb00ea7ce6 + last_write_checksum: sha1:ff60fd3b2181bc9195f6ee526b0f7e97fdf5ce7c src/polar_sdk/models/productpricesource.py: last_write_checksum: sha1:65c3c145c1e3f13ba690357a5df9fb5b7065843b src/polar_sdk/models/products_getop.py: @@ -8026,7 +8074,7 @@ trackedFiles: src/polar_sdk/models/sdkerror.py: last_write_checksum: sha1:409dc5170c233e828971025155f631c8e49dcf70 src/polar_sdk/models/seatassign.py: - last_write_checksum: sha1:0aadfc968deb22003b648235df2262d6657230b2 + last_write_checksum: sha1:db33e313f0a74121f8303ef2712f10b4aad34976 src/polar_sdk/models/seatclaim.py: last_write_checksum: sha1:8a01e747e2fd9f23c37f0f3a92048b2cea4de4a9 src/polar_sdk/models/seatclaiminfo.py: @@ -8035,10 +8083,12 @@ trackedFiles: last_write_checksum: sha1:f4c3cfec43bf46c0b7fbbb7eb2c875275daa6b4b src/polar_sdk/models/seatstatus.py: last_write_checksum: sha1:a91c6d12346d716a73864352225cd5e8de5c89bb + src/polar_sdk/models/seattiertype.py: + last_write_checksum: sha1:e7c30e34d37c6995f04eadbe60433c15c4f4c984 src/polar_sdk/models/security.py: last_write_checksum: sha1:df865d7651d0546f24c98e31068f5abc6d81d45d src/polar_sdk/models/subscription.py: - last_write_checksum: sha1:e005b2eb07792550c01f663a4c7b47cf1a6a1247 + last_write_checksum: sha1:eee3357d5965290e4bf0f1e9c413698fb2ff825c src/polar_sdk/models/subscriptionbillingperiodupdatedevent.py: last_write_checksum: sha1:9212d212f02d75cd097d0d547b917dd31a0186b1 src/polar_sdk/models/subscriptionbillingperiodupdatedmetadata.py: @@ -8133,6 +8183,8 @@ trackedFiles: last_write_checksum: sha1:af98f25883c063ee99b2a99ec3e7fb8c5af32957 src/polar_sdk/models/systemevent.py: last_write_checksum: sha1:6f188a13a99a5baf4a7d52029f26ad9b2ec56dbd + src/polar_sdk/models/taxbehavioroption.py: + last_write_checksum: sha1:5edc2dfc05982fc7b3b43d1bf942863ae98f15d4 src/polar_sdk/models/taxidformat.py: last_write_checksum: sha1:862c1fee94f466b97bca3dbb729c1434e48c4068 src/polar_sdk/models/timeinterval.py: @@ -8260,43 +8312,43 @@ trackedFiles: src/polar_sdk/oauth2.py: last_write_checksum: sha1:1b91d39369048f3144e8eeb4030a2f6d925ae110 src/polar_sdk/orders.py: - last_write_checksum: sha1:da79d8c3cd6a470f59eceb0833858041b235f4d7 + last_write_checksum: sha1:ea5810914173c230c02903447add275c79b5f0fd src/polar_sdk/organization_access_tokens.py: - last_write_checksum: sha1:8cf54b9d577f683bc1f1b5ef644462c1cd14c0f7 + last_write_checksum: sha1:6374fdee457a7077f53ade2bb5aec35fafcd5e06 src/polar_sdk/organizations.py: - last_write_checksum: sha1:2696f69c385c2542bf095770d3f9cf6cfcd26b90 + last_write_checksum: sha1:e6589be08f2b48389c048196be12a44a974659c3 src/polar_sdk/payments.py: - last_write_checksum: sha1:311ca9395ef0b9d0a579414a36b151d0986b4b29 + last_write_checksum: sha1:46877e7cedb7c6012364b19be84c7b795eb5dac9 src/polar_sdk/polar_benefit_grants.py: - last_write_checksum: sha1:5e45afeb865ab6a8e38fdbcc5ff45e31ff00ce8b + last_write_checksum: sha1:71a559c730feb448ac3379b466158fade95be8c7 src/polar_sdk/polar_customer_meters.py: - last_write_checksum: sha1:dad609163023492ad9c8c708a5ac99b0bf0ea3ce + last_write_checksum: sha1:aa476717a44c0a17af628a6d10f5797ff4ff7959 src/polar_sdk/polar_customers.py: - last_write_checksum: sha1:b0d80ca28f0fb2daee71a280e0bbf9ba286ba865 + last_write_checksum: sha1:69ad6a9876dee5ade389aae09bfbea52a3f5aff0 src/polar_sdk/polar_license_keys.py: - last_write_checksum: sha1:75997994283cccc16779f102e1a3a07fca6159e7 + last_write_checksum: sha1:2c8121503a8f60446d756b15a71c45bf90b02534 src/polar_sdk/polar_members.py: - last_write_checksum: sha1:27059544a7fd3e8032f544080b8c6820f0b465e8 + last_write_checksum: sha1:635d21c060a4273d28726818f4148a31c2155b11 src/polar_sdk/polar_orders.py: - last_write_checksum: sha1:6273c076f7a11f953f593c8e02cdd3b224973f9e + last_write_checksum: sha1:813e7cd953b6e029875a9635a7c039fb55d272d0 src/polar_sdk/polar_organizations.py: last_write_checksum: sha1:c3fdbec28b4b0c971dbc09c92937d879e791c155 src/polar_sdk/polar_subscriptions.py: - last_write_checksum: sha1:c1719969d9c6fda773d6bfaa6956a1cd629a5595 + last_write_checksum: sha1:aae56ded33f47ad3e61388617bffb7a0f831b1f6 src/polar_sdk/products.py: - last_write_checksum: sha1:7aae3384b9362d94a4013f9c7cdf7b2f26f9820b + last_write_checksum: sha1:563b205169a7034d981276ef34bfcf2880719d5d src/polar_sdk/py.typed: last_write_checksum: sha1:8efc425ffe830805ffcc0f3055871bdcdc542c60 src/polar_sdk/refunds.py: - last_write_checksum: sha1:5951c3e3c9d528448a77e28116cf60c193c3eec9 + last_write_checksum: sha1:72f767ce796c5363a3e19469e0a2e2532dfd2288 src/polar_sdk/sdk.py: last_write_checksum: sha1:8546539ea54f6b9708eff5e463e91e3059f27273 src/polar_sdk/sdkconfiguration.py: last_write_checksum: sha1:b9b14902f71407dd21a4b209f2e342c54a0a86a7 src/polar_sdk/seats.py: - last_write_checksum: sha1:3ac8c197148291dc5227e2a773cf860bdc454e0f + last_write_checksum: sha1:4e46dfb2ecc5506e5b0764722986e73768f7f64e src/polar_sdk/subscriptions.py: - last_write_checksum: sha1:3803f998fa6937a1008c284562742d0277d59f03 + last_write_checksum: sha1:c569cfeccddaf6a8621602aba7871291fed12c33 src/polar_sdk/types/__init__.py: last_write_checksum: sha1:140ebdd01a46f92ffc710c52c958c4eba3cf68ed src/polar_sdk/types/basemodel.py: @@ -8312,7 +8364,7 @@ trackedFiles: src/polar_sdk/utils/enums.py: last_write_checksum: sha1:bc8c3c1285ae09ba8a094ee5c3d9c7f41fa1284d src/polar_sdk/utils/eventstreaming.py: - last_write_checksum: sha1:ffa870a25a7e4e2015bfd7a467ccd3aa1de97f0e + last_write_checksum: sha1:620d78a8b4e3b854e08d136e02e40a01a786bd70 src/polar_sdk/utils/forms.py: last_write_checksum: sha1:15fa7e9ab1611e062a9984cf06cb20969713d295 src/polar_sdk/utils/headers.py: @@ -8338,6 +8390,6 @@ trackedFiles: src/polar_sdk/utils/values.py: last_write_checksum: sha1:acaa178a7c41ddd000f58cc691e4632d925b2553 src/polar_sdk/wallets.py: - last_write_checksum: sha1:10f7145f86d70c1430135f1490950e97df28d2d5 + last_write_checksum: sha1:7c58f7c7f4194aedc14122e757a26e0dc9f2c011 src/polar_sdk/webhooks.py: - last_write_checksum: sha1:04f9e5f5d3400e67bdf3d6fa3053839c41eded54 + last_write_checksum: sha1:b43db4d151311c1a6427def024131bd611d5dafe diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index c87d645c..617f3bab 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -31,7 +31,7 @@ generation: persistentEdits: {} versioningStrategy: automatic python: - version: 0.30.1 + version: 0.30.2 additionalDependencies: dev: pydantic-ai-slim: ^0.1.0 diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 79d5bcea..029e13e9 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -2,20 +2,20 @@ speakeasyVersion: 1.648.0 sources: Polar-OAS: sourceNamespace: polar-oas - sourceRevisionDigest: sha256:9de956700748d4ba74ceab55071b988d29ff7e364d0b08547c4d2dd9da6a5c59 - sourceBlobDigest: sha256:489987e5f6a3eec64ceed3ce48910664ac321fd652ba273a30a585b6cc27eee9 + sourceRevisionDigest: sha256:a4451ec458dd8659e13efc7b3c15e9c7b7a47d1721d33a95f2de8316f7095b32 + sourceBlobDigest: sha256:14e8c7ea016214aa3fe8e15efa0e8afb4ee218685fe9983f91fbfd40121d86da tags: - latest - - speakeasy-sdk-regen-1772756675 + - speakeasy-sdk-regen-1773274673 - 0.1.0 targets: polar: source: Polar-OAS sourceNamespace: polar-oas - sourceRevisionDigest: sha256:9de956700748d4ba74ceab55071b988d29ff7e364d0b08547c4d2dd9da6a5c59 - sourceBlobDigest: sha256:489987e5f6a3eec64ceed3ce48910664ac321fd652ba273a30a585b6cc27eee9 + sourceRevisionDigest: sha256:a4451ec458dd8659e13efc7b3c15e9c7b7a47d1721d33a95f2de8316f7095b32 + sourceBlobDigest: sha256:14e8c7ea016214aa3fe8e15efa0e8afb4ee218685fe9983f91fbfd40121d86da codeSamplesNamespace: polar-oas-py-code-samples - codeSamplesRevisionDigest: sha256:095bb2040067efcbeb7e8a31d6492c882ef0f308671348f4c0d76e108ecdaded + codeSamplesRevisionDigest: sha256:5d5d276bdd724ee39bd517b9faddbb176c736ffd6dfff7ddda67d74f1de283ef workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/README.md b/README.md index 934d1ba1..9478668c 100644 --- a/README.md +++ b/README.md @@ -576,7 +576,7 @@ with Polar( * [`PolarError`](./src/polar_sdk/models/polarerror.py): The base class for HTTP error responses. * [`HTTPValidationError`](./src/polar_sdk/models/httpvalidationerror.py): Validation Error. Status code `422`. * -
Less common errors (23) +
Less common errors (24)
@@ -596,6 +596,7 @@ with Polar( * [`PaymentNotReady`](./src/polar_sdk/models/paymentnotready.py): The checkout is expired, the customer already has an active subscription, or the organization is not ready to accept payments. Status code `403`. Applicable to 3 of 169 methods.* * [`TrialAlreadyRedeemed`](./src/polar_sdk/models/trialalreadyredeemed.py): The checkout is expired, the customer already has an active subscription, or the organization is not ready to accept payments. Status code `403`. Applicable to 3 of 169 methods.* * [`ExpiredCheckoutError`](./src/polar_sdk/models/expiredcheckouterror.py): The checkout session is expired. Status code `410`. Applicable to 3 of 169 methods.* +* [`PaymentFailed`](./src/polar_sdk/models/paymentfailed.py): Payment required to apply the subscription update. Status code `402`. Applicable to 2 of 169 methods.* * [`SubscriptionLocked`](./src/polar_sdk/models/subscriptionlocked.py): Subscription is pending an update. Status code `409`. Applicable to 2 of 169 methods.* * [`MissingInvoiceBillingDetails`](./src/polar_sdk/models/missinginvoicebillingdetails.py): Order is not paid or is missing billing name or address. Status code `422`. Applicable to 2 of 169 methods.* * [`NotPaidOrder`](./src/polar_sdk/models/notpaidorder.py): Order is not paid or is missing billing name or address. Status code `422`. Applicable to 2 of 169 methods.* diff --git a/RELEASES.md b/RELEASES.md index 07caa119..6b59e471 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -1053,4 +1053,14 @@ Based on: ### Generated - [python v0.30.1] . ### Releases -- [PyPI v0.30.1] https://pypi.org/project/polar-sdk/0.30.1 - . \ No newline at end of file +- [PyPI v0.30.1] https://pypi.org/project/polar-sdk/0.30.1 - . + +## 2026-03-26 00:22:58 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.648.0 (2.737.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v0.30.2] . +### Releases +- [PyPI v0.30.2] https://pypi.org/project/polar-sdk/0.30.2 - . \ No newline at end of file diff --git a/codeSamples.yaml b/codeSamples.yaml index fe298e3c..1e8bbb37 100644 --- a/codeSamples.yaml +++ b/codeSamples.yaml @@ -86,7 +86,7 @@ actions: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\n\n\nwith Polar(\n access_token=\"\",\n) as polar:\n\n res = polar.checkouts.create(request={\n \"customer_name\": \"John Doe\",\n \"customer_billing_address\": {\n \"country\": polar_sdk.CountryAlpha2Input.US,\n },\n \"locale\": \"en\",\n \"products\": [\n \"\",\n \"\",\n \"\",\n ],\n })\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\n\n\nwith Polar(\n access_token=\"\",\n) as polar:\n\n res = polar.checkouts.create(request={\n \"customer_name\": \"John Doe\",\n \"customer_billing_address\": {\n \"country\": polar_sdk.AddressInputCountryAlpha2Input.US,\n },\n \"locale\": \"en\",\n \"products\": [\n \"\",\n \"\",\n \"\",\n ],\n })\n\n # Handle response\n print(res)" - target: $["paths"]["/v1/checkouts/client/{client_secret}"]["get"] update: "x-codeSamples": @@ -104,7 +104,7 @@ actions: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\n\n\nwith Polar(\n access_token=\"\",\n) as polar:\n\n res = polar.checkouts.client_confirm(client_secret=\"\", checkout_confirm_stripe={\n \"customer_name\": \"John Doe\",\n \"customer_billing_address\": {\n \"country\": polar_sdk.CountryAlpha2Input.US,\n },\n \"locale\": \"en\",\n \"allow_trial\": False,\n })\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\n\n\nwith Polar(\n access_token=\"\",\n) as polar:\n\n res = polar.checkouts.client_confirm(client_secret=\"\", checkout_confirm_stripe={\n \"customer_name\": \"John Doe\",\n \"customer_billing_address\": {\n \"country\": polar_sdk.AddressInputCountryAlpha2Input.US,\n },\n \"locale\": \"en\",\n \"allow_trial\": False,\n })\n\n # Handle response\n print(res)" - target: $["paths"]["/v1/checkouts/{id}"]["get"] update: "x-codeSamples": @@ -116,7 +116,7 @@ actions: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\n\n\nwith Polar(\n access_token=\"\",\n) as polar:\n\n res = polar.checkouts.update(id=\"\", checkout_update={\n \"customer_name\": \"John Doe\",\n \"customer_billing_address\": {\n \"country\": polar_sdk.CountryAlpha2Input.US,\n },\n \"locale\": \"en\",\n })\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\n\n\nwith Polar(\n access_token=\"\",\n) as polar:\n\n res = polar.checkouts.update(id=\"\", checkout_update={\n \"customer_name\": \"John Doe\",\n \"customer_billing_address\": {\n \"country\": polar_sdk.AddressInputCountryAlpha2Input.US,\n },\n \"locale\": \"en\",\n })\n\n # Handle response\n print(res)" - target: $["paths"]["/v1/custom-fields/"]["get"] update: "x-codeSamples": @@ -200,7 +200,7 @@ actions: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\n\n\nwith Polar() as polar:\n\n res = polar.customer_portal.customers.update(security=polar_sdk.CustomerPortalCustomersUpdateSecurity(\n customer_session=\"\",\n ), request={\n \"billing_address\": {\n \"country\": polar_sdk.CountryAlpha2Input.US,\n },\n })\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\n\n\nwith Polar() as polar:\n\n res = polar.customer_portal.customers.update(security=polar_sdk.CustomerPortalCustomersUpdateSecurity(\n customer_session=\"\",\n ), request={\n \"billing_address\": {\n \"country\": polar_sdk.AddressInputCountryAlpha2Input.US,\n },\n })\n\n # Handle response\n print(res)" - target: $["paths"]["/v1/customer-portal/customers/me/payment-methods"]["get"] update: "x-codeSamples": @@ -314,7 +314,7 @@ actions: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\n\n\nwith Polar() as polar:\n\n res = polar.customer_portal.orders.update(security=polar_sdk.CustomerPortalOrdersUpdateSecurity(\n customer_session=\"\",\n ), id=\"\", customer_order_update={\n \"billing_address\": {\n \"country\": polar_sdk.CountryAlpha2Input.US,\n },\n })\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\n\n\nwith Polar() as polar:\n\n res = polar.customer_portal.orders.update(security=polar_sdk.CustomerPortalOrdersUpdateSecurity(\n customer_session=\"\",\n ), id=\"\", customer_order_update={\n \"billing_address\": {\n \"country\": polar_sdk.AddressInputCountryAlpha2Input.US,\n },\n })\n\n # Handle response\n print(res)" - target: $["paths"]["/v1/customer-portal/orders/{id}/confirm-payment"]["post"] update: "x-codeSamples": @@ -464,7 +464,7 @@ actions: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\n\n\nwith Polar(\n access_token=\"\",\n) as polar:\n\n res = polar.customers.create(request={\n \"external_id\": \"usr_1337\",\n \"email\": \"customer@example.com\",\n \"name\": \"John Doe\",\n \"billing_address\": {\n \"country\": polar_sdk.CountryAlpha2Input.US,\n },\n \"locale\": \"en\",\n \"type\": polar_sdk.CustomerType.INDIVIDUAL,\n \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n \"owner\": {\n \"email\": \"member@example.com\",\n \"name\": \"Jane Doe\",\n \"external_id\": \"usr_1337\",\n },\n })\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\n\n\nwith Polar(\n access_token=\"\",\n) as polar:\n\n res = polar.customers.create(request={\n \"external_id\": \"usr_1337\",\n \"email\": \"customer@example.com\",\n \"name\": \"John Doe\",\n \"billing_address\": {\n \"country\": polar_sdk.AddressInputCountryAlpha2Input.US,\n },\n \"locale\": \"en\",\n \"type\": polar_sdk.CustomerType.INDIVIDUAL,\n \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n \"owner\": {\n \"email\": \"member@example.com\",\n \"name\": \"Jane Doe\",\n \"external_id\": \"usr_1337\",\n },\n })\n\n # Handle response\n print(res)" - target: $["paths"]["/v1/customers/export"]["get"] update: "x-codeSamples": @@ -512,7 +512,7 @@ actions: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\n\n\nwith Polar(\n access_token=\"\",\n) as polar:\n\n res = polar.customers.update(id=\"\", customer_update={\n \"email\": \"customer@example.com\",\n \"name\": \"John Doe\",\n \"billing_address\": {\n \"country\": polar_sdk.CountryAlpha2Input.US,\n },\n \"locale\": \"en\",\n \"external_id\": \"usr_1337\",\n \"type\": polar_sdk.CustomerType.INDIVIDUAL,\n })\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\n\n\nwith Polar(\n access_token=\"\",\n) as polar:\n\n res = polar.customers.update(id=\"\", customer_update={\n \"email\": \"customer@example.com\",\n \"name\": \"John Doe\",\n \"billing_address\": {\n \"country\": polar_sdk.AddressInputCountryAlpha2Input.US,\n },\n \"locale\": \"en\",\n \"external_id\": \"usr_1337\",\n \"type\": polar_sdk.CustomerType.INDIVIDUAL,\n })\n\n # Handle response\n print(res)" - target: $["paths"]["/v1/customers/{id}/state"]["get"] update: "x-codeSamples": @@ -818,7 +818,7 @@ actions: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\n\n\nwith Polar(\n access_token=\"\",\n) as polar:\n\n res = polar.orders.update(id=\"\", order_update={\n \"billing_address\": {\n \"country\": polar_sdk.CountryAlpha2Input.US,\n },\n })\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\n\n\nwith Polar(\n access_token=\"\",\n) as polar:\n\n res = polar.orders.update(id=\"\", order_update={\n \"billing_address\": {\n \"country\": polar_sdk.AddressInputCountryAlpha2Input.US,\n },\n })\n\n # Handle response\n print(res)" - target: $["paths"]["/v1/orders/{id}/invoice"]["get"] update: "x-codeSamples": @@ -1034,13 +1034,13 @@ actions: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointbenefit_grant_created_post(request=polar_sdk.WebhookBenefitGrantCreatedPayload(\n timestamp=parse_datetime(\"2026-07-29T09:12:26.895Z\"),\n data=polar_sdk.BenefitGrantGitHubRepositoryWebhook(\n created_at=parse_datetime(\"2026-07-26T11:51:14.320Z\"),\n modified_at=parse_datetime(\"2024-06-25T18:19:56.152Z\"),\n id=\"\",\n is_granted=False,\n is_revoked=True,\n subscription_id=\"\",\n order_id=\"\",\n customer_id=\"\",\n benefit_id=\"\",\n customer=polar_sdk.Customer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2026-05-12T01:27:02.379Z\"),\n modified_at=parse_datetime(\"2024-11-16T04:22:37.821Z\"),\n metadata={\n\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2024-02-21T01:01:33.050Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n member=polar_sdk.Member(\n id=\"\",\n created_at=parse_datetime(\"2024-10-15T11:07:39.330Z\"),\n modified_at=parse_datetime(\"2025-12-21T23:42:07.643Z\"),\n customer_id=\"\",\n email=\"member@example.com\",\n name=\"Jane Doe\",\n external_id=\"usr_1337\",\n role=polar_sdk.MemberRole.BILLING_MANAGER,\n ),\n benefit=polar_sdk.BenefitGitHubRepository(\n id=\"\",\n created_at=parse_datetime(\"2024-06-11T14:51:22.188Z\"),\n modified_at=parse_datetime(\"2024-06-03T11:09:21.440Z\"),\n description=\"vibraphone however abseil yet conservative\",\n selectable=False,\n deletable=True,\n organization_id=\"\",\n metadata={\n \"key\": \"\",\n },\n properties=polar_sdk.BenefitGitHubRepositoryProperties(\n repository_owner=\"polarsource\",\n repository_name=\"private_repo\",\n permission=polar_sdk.Permission.TRIAGE,\n ),\n ),\n properties=polar_sdk.BenefitGrantGitHubRepositoryProperties(),\n ),\n ))\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointbenefit_grant_created_post(request=polar_sdk.WebhookBenefitGrantCreatedPayload(\n timestamp=parse_datetime(\"2026-07-29T09:12:26.895Z\"),\n data=polar_sdk.BenefitGrantGitHubRepositoryWebhook(\n created_at=parse_datetime(\"2026-07-26T11:51:14.320Z\"),\n modified_at=parse_datetime(\"2024-06-25T18:19:56.152Z\"),\n id=\"\",\n is_granted=False,\n is_revoked=True,\n subscription_id=\"\",\n order_id=\"\",\n customer_id=\"\",\n benefit_id=\"\",\n customer=polar_sdk.Customer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2026-05-12T01:27:02.379Z\"),\n modified_at=parse_datetime(\"2024-11-16T04:22:37.821Z\"),\n metadata={\n\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2024-02-21T01:01:33.050Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n member=polar_sdk.Member(\n id=\"\",\n created_at=parse_datetime(\"2024-10-15T11:07:39.330Z\"),\n modified_at=parse_datetime(\"2025-12-21T23:42:07.643Z\"),\n customer_id=\"\",\n email=\"member@example.com\",\n name=\"Jane Doe\",\n external_id=\"usr_1337\",\n role=polar_sdk.MemberRole.BILLING_MANAGER,\n ),\n benefit=polar_sdk.BenefitGitHubRepository(\n id=\"\",\n created_at=parse_datetime(\"2024-06-11T14:51:22.188Z\"),\n modified_at=parse_datetime(\"2024-06-03T11:09:21.440Z\"),\n description=\"vibraphone however abseil yet conservative\",\n selectable=False,\n deletable=True,\n organization_id=\"\",\n metadata={\n \"key\": \"\",\n },\n properties=polar_sdk.BenefitGitHubRepositoryProperties(\n repository_owner=\"polarsource\",\n repository_name=\"private_repo\",\n permission=polar_sdk.Permission.TRIAGE,\n ),\n ),\n properties=polar_sdk.BenefitGrantGitHubRepositoryProperties(),\n ),\n ))\n\n # Handle response\n print(res)" - target: $["paths"]["benefit_grant.cycled"]["post"] update: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointbenefit_grant_cycled_post(request=polar_sdk.WebhookBenefitGrantCycledPayload(\n timestamp=parse_datetime(\"2024-11-20T13:26:50.948Z\"),\n data=polar_sdk.BenefitGrantDiscordWebhook(\n created_at=parse_datetime(\"2024-07-18T03:56:32.649Z\"),\n modified_at=parse_datetime(\"2026-06-08T22:06:37.934Z\"),\n id=\"\",\n is_granted=False,\n is_revoked=False,\n subscription_id=\"\",\n order_id=\"\",\n customer_id=\"\",\n benefit_id=\"\",\n customer=polar_sdk.Customer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2025-06-18T10:06:52.830Z\"),\n modified_at=parse_datetime(\"2025-06-29T04:36:34.181Z\"),\n metadata={\n\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2026-09-22T10:01:13.690Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n member=polar_sdk.Member(\n id=\"\",\n created_at=parse_datetime(\"2026-07-14T03:36:29.696Z\"),\n modified_at=parse_datetime(\"2024-08-19T01:19:24.073Z\"),\n customer_id=\"\",\n email=\"member@example.com\",\n name=\"Jane Doe\",\n external_id=\"usr_1337\",\n role=polar_sdk.MemberRole.MEMBER,\n ),\n benefit=polar_sdk.BenefitDiscord(\n id=\"\",\n created_at=parse_datetime(\"2026-02-04T13:44:07.858Z\"),\n modified_at=parse_datetime(\"2025-09-30T08:45:47.468Z\"),\n description=\"tenderly up an instead expensive made-up pace\",\n selectable=False,\n deletable=True,\n organization_id=\"\",\n metadata={\n \"key\": \"\",\n },\n properties=polar_sdk.BenefitDiscordProperties(\n guild_id=\"\",\n role_id=\"\",\n kick_member=True,\n guild_token=\"\",\n ),\n ),\n properties=polar_sdk.BenefitGrantDiscordProperties(),\n ),\n ))\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointbenefit_grant_cycled_post(request=polar_sdk.WebhookBenefitGrantCycledPayload(\n timestamp=parse_datetime(\"2024-11-20T13:26:50.948Z\"),\n data=polar_sdk.BenefitGrantDiscordWebhook(\n created_at=parse_datetime(\"2024-07-18T03:56:32.649Z\"),\n modified_at=parse_datetime(\"2026-06-08T22:06:37.934Z\"),\n id=\"\",\n is_granted=False,\n is_revoked=False,\n subscription_id=\"\",\n order_id=\"\",\n customer_id=\"\",\n benefit_id=\"\",\n customer=polar_sdk.Customer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2025-06-18T10:06:52.830Z\"),\n modified_at=parse_datetime(\"2025-06-29T04:36:34.181Z\"),\n metadata={\n\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2026-09-22T10:01:13.690Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n member=polar_sdk.Member(\n id=\"\",\n created_at=parse_datetime(\"2026-07-14T03:36:29.696Z\"),\n modified_at=parse_datetime(\"2024-08-19T01:19:24.073Z\"),\n customer_id=\"\",\n email=\"member@example.com\",\n name=\"Jane Doe\",\n external_id=\"usr_1337\",\n role=polar_sdk.MemberRole.MEMBER,\n ),\n benefit=polar_sdk.BenefitDiscord(\n id=\"\",\n created_at=parse_datetime(\"2026-02-04T13:44:07.858Z\"),\n modified_at=parse_datetime(\"2025-09-30T08:45:47.468Z\"),\n description=\"tenderly up an instead expensive made-up pace\",\n selectable=False,\n deletable=True,\n organization_id=\"\",\n metadata={\n \"key\": \"\",\n },\n properties=polar_sdk.BenefitDiscordProperties(\n guild_id=\"\",\n role_id=\"\",\n kick_member=True,\n guild_token=\"\",\n ),\n ),\n properties=polar_sdk.BenefitGrantDiscordProperties(),\n ),\n ))\n\n # Handle response\n print(res)" - target: $["paths"]["benefit_grant.revoked"]["post"] update: "x-codeSamples": @@ -1052,49 +1052,49 @@ actions: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointbenefit_grant_updated_post(request=polar_sdk.WebhookBenefitGrantUpdatedPayload(\n timestamp=parse_datetime(\"2024-06-14T00:42:20.858Z\"),\n data=polar_sdk.BenefitGrantLicenseKeysWebhook(\n created_at=parse_datetime(\"2024-09-08T02:35:13.085Z\"),\n modified_at=parse_datetime(\"2025-04-28T04:44:42.040Z\"),\n id=\"\",\n is_granted=True,\n is_revoked=False,\n subscription_id=\"\",\n order_id=\"\",\n customer_id=\"\",\n benefit_id=\"\",\n customer=polar_sdk.Customer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2025-06-22T06:57:35.281Z\"),\n modified_at=parse_datetime(\"2026-06-14T15:07:20.731Z\"),\n metadata={\n \"key\": 322224,\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2026-09-29T05:46:04.457Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n member=polar_sdk.Member(\n id=\"\",\n created_at=parse_datetime(\"2025-09-28T22:38:44.093Z\"),\n modified_at=parse_datetime(\"2025-06-05T03:01:15.151Z\"),\n customer_id=\"\",\n email=\"member@example.com\",\n name=\"Jane Doe\",\n external_id=\"usr_1337\",\n role=polar_sdk.MemberRole.BILLING_MANAGER,\n ),\n benefit=polar_sdk.BenefitLicenseKeys(\n id=\"\",\n created_at=parse_datetime(\"2025-06-23T01:13:04.636Z\"),\n modified_at=parse_datetime(\"2025-11-30T14:06:15.982Z\"),\n description=\"hm waterlogged vastly widow lay\",\n selectable=False,\n deletable=True,\n organization_id=\"\",\n metadata={\n \"key\": \"\",\n },\n properties=polar_sdk.BenefitLicenseKeysProperties(\n prefix=\"\",\n expires=polar_sdk.BenefitLicenseKeyExpirationProperties(\n ttl=618571,\n timeframe=polar_sdk.Timeframe.MONTH,\n ),\n activations=polar_sdk.BenefitLicenseKeyActivationProperties(\n limit=50388,\n enable_customer_admin=True,\n ),\n limit_usage=550150,\n ),\n ),\n properties=polar_sdk.BenefitGrantLicenseKeysProperties(),\n ),\n ))\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointbenefit_grant_updated_post(request=polar_sdk.WebhookBenefitGrantUpdatedPayload(\n timestamp=parse_datetime(\"2024-06-14T00:42:20.858Z\"),\n data=polar_sdk.BenefitGrantLicenseKeysWebhook(\n created_at=parse_datetime(\"2024-09-08T02:35:13.085Z\"),\n modified_at=parse_datetime(\"2025-04-28T04:44:42.040Z\"),\n id=\"\",\n is_granted=True,\n is_revoked=False,\n subscription_id=\"\",\n order_id=\"\",\n customer_id=\"\",\n benefit_id=\"\",\n customer=polar_sdk.Customer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2025-06-22T06:57:35.281Z\"),\n modified_at=parse_datetime(\"2026-06-14T15:07:20.731Z\"),\n metadata={\n \"key\": 322224,\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2026-09-29T05:46:04.457Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n member=polar_sdk.Member(\n id=\"\",\n created_at=parse_datetime(\"2025-09-28T22:38:44.093Z\"),\n modified_at=parse_datetime(\"2025-06-05T03:01:15.151Z\"),\n customer_id=\"\",\n email=\"member@example.com\",\n name=\"Jane Doe\",\n external_id=\"usr_1337\",\n role=polar_sdk.MemberRole.BILLING_MANAGER,\n ),\n benefit=polar_sdk.BenefitLicenseKeys(\n id=\"\",\n created_at=parse_datetime(\"2025-06-23T01:13:04.636Z\"),\n modified_at=parse_datetime(\"2025-11-30T14:06:15.982Z\"),\n description=\"hm waterlogged vastly widow lay\",\n selectable=False,\n deletable=True,\n organization_id=\"\",\n metadata={\n \"key\": \"\",\n },\n properties=polar_sdk.BenefitLicenseKeysProperties(\n prefix=\"\",\n expires=polar_sdk.BenefitLicenseKeyExpirationProperties(\n ttl=618571,\n timeframe=polar_sdk.Timeframe.MONTH,\n ),\n activations=polar_sdk.BenefitLicenseKeyActivationProperties(\n limit=50388,\n enable_customer_admin=True,\n ),\n limit_usage=550150,\n ),\n ),\n properties=polar_sdk.BenefitGrantLicenseKeysProperties(),\n ),\n ))\n\n # Handle response\n print(res)" - target: $["paths"]["checkout.created"]["post"] update: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointcheckout_created_post(request=polar_sdk.WebhookCheckoutCreatedPayload(\n timestamp=parse_datetime(\"2024-02-15T15:44:21.478Z\"),\n data=polar_sdk.Checkout(\n id=\"\",\n created_at=parse_datetime(\"2026-09-12T19:48:15.814Z\"),\n modified_at=parse_datetime(\"2024-09-13T02:01:27.394Z\"),\n payment_processor=polar_sdk.PaymentProcessor.STRIPE,\n status=polar_sdk.CheckoutStatus.EXPIRED,\n client_secret=\"\",\n url=\"https://agreeable-reboot.biz\",\n expires_at=parse_datetime(\"2025-05-02T18:25:33.974Z\"),\n success_url=\"https://rural-outrun.org\",\n return_url=\"https://clean-humidity.com/\",\n embed_origin=\"\",\n amount=275553,\n discount_amount=9980,\n net_amount=266632,\n tax_amount=348968,\n total_amount=203013,\n currency=\"Australian Dollar\",\n allow_trial=True,\n active_trial_interval=polar_sdk.TrialInterval.MONTH,\n active_trial_interval_count=47757,\n trial_end=None,\n organization_id=\"\",\n product_id=\"\",\n product_price_id=\"\",\n discount_id=\"\",\n allow_discount_codes=False,\n require_billing_address=False,\n is_discount_applicable=False,\n is_free_product_price=False,\n is_payment_required=False,\n is_payment_setup_required=False,\n is_payment_form_required=False,\n customer_id=\"\",\n is_business_customer=False,\n customer_name=\"\",\n customer_email=\"\",\n customer_ip_address=\"\",\n customer_billing_name=\"\",\n customer_billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n customer_tax_id=\"\",\n payment_processor_metadata={\n\n },\n billing_address_fields=polar_sdk.CheckoutBillingAddressFields(\n country=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n state=polar_sdk.BillingAddressFieldMode.DISABLED,\n city=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n postal_code=polar_sdk.BillingAddressFieldMode.REQUIRED,\n line1=polar_sdk.BillingAddressFieldMode.DISABLED,\n line2=polar_sdk.BillingAddressFieldMode.REQUIRED,\n ),\n trial_interval=polar_sdk.TrialInterval.MONTH,\n trial_interval_count=945017,\n metadata={\n\n },\n external_customer_id=\"\",\n products=[],\n product=polar_sdk.CheckoutProduct(\n id=\"\",\n created_at=parse_datetime(\"2024-01-06T18:09:03.676Z\"),\n modified_at=parse_datetime(\"2025-05-28T21:42:41.690Z\"),\n trial_interval=polar_sdk.TrialInterval.MONTH,\n trial_interval_count=590205,\n name=\"\",\n description=\"structure tenderly dirty colon though\",\n visibility=polar_sdk.ProductVisibility.DRAFT,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.YEAR,\n recurring_interval_count=265994,\n is_recurring=True,\n is_archived=True,\n organization_id=\"\",\n prices=[\n polar_sdk.LegacyRecurringProductPriceCustom(\n created_at=parse_datetime(\"2024-04-20T04:12:36.083Z\"),\n modified_at=None,\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n is_archived=True,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n minimum_amount=554797,\n maximum_amount=721879,\n preset_amount=559368,\n ),\n ],\n benefits=[\n polar_sdk.BenefitPublic(\n id=\"\",\n created_at=parse_datetime(\"2025-08-28T17:10:35.995Z\"),\n modified_at=parse_datetime(\"2026-03-07T18:00:48.486Z\"),\n type=polar_sdk.BenefitType.DOWNLOADABLES,\n description=\"unless cheerfully glaring home indolent frequent highly topsail memorable\",\n selectable=False,\n deletable=True,\n organization_id=\"\",\n ),\n ],\n medias=[\n polar_sdk.ProductMediaFileRead(\n id=\"\",\n organization_id=\"\",\n name=\"\",\n path=\"/proc\",\n mime_type=\"\",\n size=246349,\n storage_version=\"\",\n checksum_etag=None,\n checksum_sha256_base64=\"\",\n checksum_sha256_hex=\"\",\n last_modified_at=parse_datetime(\"2025-01-08T19:17:50.328Z\"),\n version=\"\",\n is_uploaded=False,\n created_at=parse_datetime(\"2026-08-14T14:21:21.921Z\"),\n size_readable=\"\",\n public_url=\"https://winged-zen.org/\",\n ),\n ],\n ),\n product_price=polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2025-03-23T13:16:28.157Z\"),\n modified_at=parse_datetime(\"2026-01-04T20:37:57.211Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n is_archived=True,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,\n price_amount=287910,\n ),\n prices={\n \"key\": [\n polar_sdk.ProductPriceMeteredUnit(\n created_at=parse_datetime(\"2026-05-12T08:03:19.061Z\"),\n modified_at=parse_datetime(\"2024-09-11T20:26:20.871Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.CATALOG,\n price_currency=\"\",\n is_archived=False,\n product_id=\"\",\n unit_amount=\"\",\n cap_amount=105515,\n meter_id=\"\",\n meter=polar_sdk.ProductPriceMeter(\n id=\"\",\n name=\"\",\n ),\n ),\n ],\n },\n discount=None,\n subscription_id=\"\",\n attached_custom_fields=[\n polar_sdk.AttachedCustomField(\n custom_field_id=\"\",\n custom_field=polar_sdk.CustomFieldDate(\n created_at=parse_datetime(\"2024-03-17T19:45:29.565Z\"),\n modified_at=parse_datetime(\"2025-12-05T02:53:52.791Z\"),\n id=\"\",\n metadata={\n\n },\n slug=\"\",\n name=\"\",\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n properties=polar_sdk.CustomFieldDateProperties(),\n ),\n order=25373,\n required=True,\n ),\n ],\n customer_metadata={\n \"key\": True,\n },\n ),\n ))\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointcheckout_created_post(request=polar_sdk.WebhookCheckoutCreatedPayload(\n timestamp=parse_datetime(\"2024-02-15T15:44:21.478Z\"),\n data=polar_sdk.Checkout(\n id=\"\",\n created_at=parse_datetime(\"2026-09-12T19:48:15.814Z\"),\n modified_at=parse_datetime(\"2024-09-13T02:01:27.394Z\"),\n payment_processor=polar_sdk.PaymentProcessor.STRIPE,\n status=polar_sdk.CheckoutStatus.EXPIRED,\n client_secret=\"\",\n url=\"https://agreeable-reboot.biz\",\n expires_at=parse_datetime(\"2025-05-02T18:25:33.974Z\"),\n success_url=\"https://rural-outrun.org\",\n return_url=\"https://clean-humidity.com/\",\n embed_origin=\"\",\n amount=275553,\n discount_amount=9980,\n net_amount=266632,\n tax_amount=348968,\n total_amount=203013,\n currency=\"Australian Dollar\",\n allow_trial=True,\n active_trial_interval=polar_sdk.TrialInterval.MONTH,\n active_trial_interval_count=47757,\n trial_end=None,\n organization_id=\"\",\n product_id=\"\",\n product_price_id=\"\",\n discount_id=\"\",\n allow_discount_codes=False,\n require_billing_address=False,\n is_discount_applicable=False,\n is_free_product_price=False,\n is_payment_required=False,\n is_payment_setup_required=False,\n is_payment_form_required=False,\n customer_id=\"\",\n is_business_customer=False,\n customer_name=\"\",\n customer_email=\"\",\n customer_ip_address=\"\",\n customer_billing_name=\"\",\n customer_billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n customer_tax_id=\"\",\n payment_processor_metadata={\n\n },\n billing_address_fields=polar_sdk.CheckoutBillingAddressFields(\n country=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n state=polar_sdk.BillingAddressFieldMode.DISABLED,\n city=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n postal_code=polar_sdk.BillingAddressFieldMode.REQUIRED,\n line1=polar_sdk.BillingAddressFieldMode.DISABLED,\n line2=polar_sdk.BillingAddressFieldMode.REQUIRED,\n ),\n trial_interval=polar_sdk.TrialInterval.MONTH,\n trial_interval_count=945017,\n metadata={\n\n },\n external_customer_id=\"\",\n products=[],\n product=polar_sdk.CheckoutProduct(\n id=\"\",\n created_at=parse_datetime(\"2024-01-06T18:09:03.676Z\"),\n modified_at=parse_datetime(\"2025-05-28T21:42:41.690Z\"),\n trial_interval=polar_sdk.TrialInterval.MONTH,\n trial_interval_count=590205,\n name=\"\",\n description=\"structure tenderly dirty colon though\",\n visibility=polar_sdk.ProductVisibility.DRAFT,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.YEAR,\n recurring_interval_count=265994,\n is_recurring=True,\n is_archived=True,\n organization_id=\"\",\n prices=[\n polar_sdk.LegacyRecurringProductPriceCustom(\n created_at=parse_datetime(\"2024-04-20T04:12:36.083Z\"),\n modified_at=None,\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n tax_behavior=polar_sdk.TaxBehaviorOption.INCLUSIVE,\n is_archived=True,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n minimum_amount=721879,\n maximum_amount=559368,\n preset_amount=552660,\n ),\n ],\n benefits=[\n polar_sdk.BenefitPublic(\n id=\"\",\n created_at=parse_datetime(\"2026-03-07T18:00:48.486Z\"),\n modified_at=parse_datetime(\"2026-07-24T22:06:51.276Z\"),\n type=polar_sdk.BenefitType.LICENSE_KEYS,\n description=\"drat meanwhile ah lest neighboring zowie zowie greedily black\",\n selectable=False,\n deletable=False,\n organization_id=\"\",\n ),\n ],\n medias=[],\n ),\n product_price=polar_sdk.LegacyRecurringProductPriceCustom(\n created_at=parse_datetime(\"2025-10-31T13:05:17.822Z\"),\n modified_at=parse_datetime(\"2025-01-08T19:17:50.328Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n tax_behavior=polar_sdk.TaxBehaviorOption.EXCLUSIVE,\n is_archived=True,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.YEAR,\n minimum_amount=999511,\n maximum_amount=470604,\n preset_amount=567071,\n ),\n prices={\n \"key\": [\n polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2025-12-21T17:32:23.848Z\"),\n modified_at=parse_datetime(\"2025-10-17T07:04:10.750Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.CATALOG,\n price_currency=\"\",\n tax_behavior=polar_sdk.TaxBehaviorOption.EXCLUSIVE,\n is_archived=False,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.YEAR,\n price_amount=786803,\n ),\n ],\n \"key1\": [\n polar_sdk.LegacyRecurringProductPriceCustom(\n created_at=parse_datetime(\"2026-08-16T19:01:04.937Z\"),\n modified_at=parse_datetime(\"2024-04-25T15:28:45.523Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.CATALOG,\n price_currency=\"\",\n tax_behavior=polar_sdk.TaxBehaviorOption.EXCLUSIVE,\n is_archived=False,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n minimum_amount=70094,\n maximum_amount=642446,\n preset_amount=None,\n ),\n ],\n \"key2\": [],\n },\n discount=polar_sdk.CheckoutDiscountPercentageOnceForeverDuration(\n duration=polar_sdk.DiscountDuration.REPEATING,\n type=polar_sdk.DiscountType.FIXED,\n basis_points=1000,\n id=\"\",\n name=\"\",\n code=\"\",\n ),\n subscription_id=\"\",\n attached_custom_fields=[\n polar_sdk.AttachedCustomField(\n custom_field_id=\"\",\n custom_field=polar_sdk.CustomFieldDate(\n created_at=parse_datetime(\"2025-06-01T08:38:21.918Z\"),\n modified_at=parse_datetime(\"2024-02-18T12:09:03.075Z\"),\n id=\"\",\n metadata={\n \"key\": \"\",\n },\n slug=\"\",\n name=\"\",\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n properties=polar_sdk.CustomFieldDateProperties(),\n ),\n order=7912,\n required=True,\n ),\n ],\n customer_metadata={\n\n },\n ),\n ))\n\n # Handle response\n print(res)" - target: $["paths"]["checkout.expired"]["post"] update: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointcheckout_expired_post(request=polar_sdk.WebhookCheckoutExpiredPayload(\n timestamp=parse_datetime(\"2025-07-24T10:11:01.088Z\"),\n data=polar_sdk.Checkout(\n id=\"\",\n created_at=parse_datetime(\"2024-05-04T16:36:16.430Z\"),\n modified_at=parse_datetime(\"2025-07-14T11:38:07.998Z\"),\n payment_processor=polar_sdk.PaymentProcessor.STRIPE,\n status=polar_sdk.CheckoutStatus.OPEN,\n client_secret=\"\",\n url=\"https://husky-advertisement.biz/\",\n expires_at=parse_datetime(\"2026-08-22T23:38:29.173Z\"),\n success_url=\"https://wasteful-premeditation.org\",\n return_url=\"https://torn-toothpick.name\",\n embed_origin=\"\",\n amount=104765,\n discount_amount=723749,\n net_amount=208098,\n tax_amount=740520,\n total_amount=729691,\n currency=\"Kwanza\",\n allow_trial=True,\n active_trial_interval=polar_sdk.TrialInterval.DAY,\n active_trial_interval_count=884805,\n trial_end=parse_datetime(\"2026-12-24T16:37:35.525Z\"),\n organization_id=\"\",\n product_id=\"\",\n product_price_id=\"\",\n discount_id=\"\",\n allow_discount_codes=False,\n require_billing_address=True,\n is_discount_applicable=True,\n is_free_product_price=True,\n is_payment_required=False,\n is_payment_setup_required=True,\n is_payment_form_required=True,\n customer_id=\"\",\n is_business_customer=False,\n customer_name=\"\",\n customer_email=\"\",\n customer_ip_address=\"\",\n customer_billing_name=\"\",\n customer_billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n customer_tax_id=\"\",\n payment_processor_metadata={\n \"key\": \"\",\n \"key1\": \"\",\n \"key2\": \"\",\n },\n billing_address_fields=polar_sdk.CheckoutBillingAddressFields(\n country=polar_sdk.BillingAddressFieldMode.DISABLED,\n state=polar_sdk.BillingAddressFieldMode.REQUIRED,\n city=polar_sdk.BillingAddressFieldMode.DISABLED,\n postal_code=polar_sdk.BillingAddressFieldMode.REQUIRED,\n line1=polar_sdk.BillingAddressFieldMode.REQUIRED,\n line2=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n ),\n trial_interval=polar_sdk.TrialInterval.YEAR,\n trial_interval_count=374640,\n metadata={\n\n },\n external_customer_id=\"\",\n products=[\n polar_sdk.CheckoutProduct(\n id=\"\",\n created_at=parse_datetime(\"2024-07-19T18:56:17.115Z\"),\n modified_at=parse_datetime(\"2025-05-03T04:05:53.922Z\"),\n trial_interval=None,\n trial_interval_count=736956,\n name=\"\",\n description=\"woot absent selfishly maestro frail unethically anguished solder\",\n visibility=polar_sdk.ProductVisibility.PRIVATE,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,\n recurring_interval_count=422566,\n is_recurring=False,\n is_archived=True,\n organization_id=\"\",\n prices=[],\n benefits=[\n polar_sdk.BenefitPublic(\n id=\"\",\n created_at=parse_datetime(\"2024-02-20T20:34:14.140Z\"),\n modified_at=None,\n type=polar_sdk.BenefitType.FEATURE_FLAG,\n description=\"yawn sharply inside ah lest who into\",\n selectable=False,\n deletable=False,\n organization_id=\"\",\n ),\n ],\n medias=[],\n ),\n ],\n product=polar_sdk.CheckoutProduct(\n id=\"\",\n created_at=parse_datetime(\"2025-07-25T20:35:56.555Z\"),\n modified_at=parse_datetime(\"2025-07-29T02:50:59.712Z\"),\n trial_interval=polar_sdk.TrialInterval.WEEK,\n trial_interval_count=272557,\n name=\"\",\n description=None,\n visibility=polar_sdk.ProductVisibility.DRAFT,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n recurring_interval_count=None,\n is_recurring=False,\n is_archived=True,\n organization_id=\"\",\n prices=[\n polar_sdk.LegacyRecurringProductPriceCustom(\n created_at=parse_datetime(\"2026-12-31T01:02:14.398Z\"),\n modified_at=parse_datetime(\"2025-02-10T09:37:50.330Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n is_archived=False,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,\n minimum_amount=570455,\n maximum_amount=109251,\n preset_amount=453008,\n ),\n ],\n benefits=[\n polar_sdk.BenefitPublic(\n id=\"\",\n created_at=parse_datetime(\"2024-02-20T20:34:14.140Z\"),\n modified_at=None,\n type=polar_sdk.BenefitType.FEATURE_FLAG,\n description=\"yawn sharply inside ah lest who into\",\n selectable=False,\n deletable=False,\n organization_id=\"\",\n ),\n ],\n medias=[\n polar_sdk.ProductMediaFileRead(\n id=\"\",\n organization_id=\"\",\n name=\"\",\n path=\"/Library\",\n mime_type=\"\",\n size=404380,\n storage_version=\"\",\n checksum_etag=\"\",\n checksum_sha256_base64=\"\",\n checksum_sha256_hex=None,\n last_modified_at=parse_datetime(\"2026-07-14T04:50:58.042Z\"),\n version=\"\",\n is_uploaded=False,\n created_at=parse_datetime(\"2026-09-12T12:00:29.248Z\"),\n size_readable=\"\",\n public_url=\"https://nervous-mozzarella.net/\",\n ),\n ],\n ),\n product_price=polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2025-04-20T06:25:11.750Z\"),\n modified_at=parse_datetime(\"2026-04-04T12:09:32.090Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n is_archived=False,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,\n price_amount=334062,\n ),\n prices=None,\n discount=None,\n subscription_id=\"\",\n attached_custom_fields=[\n polar_sdk.AttachedCustomField(\n custom_field_id=\"\",\n custom_field=polar_sdk.CustomFieldNumber(\n created_at=parse_datetime(\"2026-03-05T08:28:23.107Z\"),\n modified_at=parse_datetime(\"2024-03-15T08:22:06.793Z\"),\n id=\"\",\n metadata={\n \"key\": 561911,\n },\n slug=\"\",\n name=\"\",\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n properties=polar_sdk.CustomFieldNumberProperties(),\n ),\n order=171811,\n required=False,\n ),\n ],\n customer_metadata={\n\n },\n ),\n ))\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointcheckout_expired_post(request=polar_sdk.WebhookCheckoutExpiredPayload(\n timestamp=parse_datetime(\"2025-07-24T10:11:01.088Z\"),\n data=polar_sdk.Checkout(\n id=\"\",\n created_at=parse_datetime(\"2024-05-04T16:36:16.430Z\"),\n modified_at=parse_datetime(\"2025-07-14T11:38:07.998Z\"),\n payment_processor=polar_sdk.PaymentProcessor.STRIPE,\n status=polar_sdk.CheckoutStatus.OPEN,\n client_secret=\"\",\n url=\"https://husky-advertisement.biz/\",\n expires_at=parse_datetime(\"2026-08-22T23:38:29.173Z\"),\n success_url=\"https://wasteful-premeditation.org\",\n return_url=\"https://torn-toothpick.name\",\n embed_origin=\"\",\n amount=104765,\n discount_amount=723749,\n net_amount=208098,\n tax_amount=740520,\n total_amount=729691,\n currency=\"Kwanza\",\n allow_trial=True,\n active_trial_interval=polar_sdk.TrialInterval.DAY,\n active_trial_interval_count=884805,\n trial_end=parse_datetime(\"2026-12-24T16:37:35.525Z\"),\n organization_id=\"\",\n product_id=\"\",\n product_price_id=\"\",\n discount_id=\"\",\n allow_discount_codes=False,\n require_billing_address=True,\n is_discount_applicable=True,\n is_free_product_price=True,\n is_payment_required=False,\n is_payment_setup_required=True,\n is_payment_form_required=True,\n customer_id=\"\",\n is_business_customer=False,\n customer_name=\"\",\n customer_email=\"\",\n customer_ip_address=\"\",\n customer_billing_name=\"\",\n customer_billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n customer_tax_id=\"\",\n payment_processor_metadata={\n \"key\": \"\",\n \"key1\": \"\",\n \"key2\": \"\",\n },\n billing_address_fields=polar_sdk.CheckoutBillingAddressFields(\n country=polar_sdk.BillingAddressFieldMode.DISABLED,\n state=polar_sdk.BillingAddressFieldMode.REQUIRED,\n city=polar_sdk.BillingAddressFieldMode.DISABLED,\n postal_code=polar_sdk.BillingAddressFieldMode.REQUIRED,\n line1=polar_sdk.BillingAddressFieldMode.REQUIRED,\n line2=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n ),\n trial_interval=polar_sdk.TrialInterval.YEAR,\n trial_interval_count=374640,\n metadata={\n\n },\n external_customer_id=\"\",\n products=[\n polar_sdk.CheckoutProduct(\n id=\"\",\n created_at=parse_datetime(\"2024-07-19T18:56:17.115Z\"),\n modified_at=parse_datetime(\"2025-05-03T04:05:53.922Z\"),\n trial_interval=None,\n trial_interval_count=736956,\n name=\"\",\n description=\"woot absent selfishly maestro frail unethically anguished solder\",\n visibility=polar_sdk.ProductVisibility.PRIVATE,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,\n recurring_interval_count=422566,\n is_recurring=False,\n is_archived=True,\n organization_id=\"\",\n prices=[],\n benefits=[\n polar_sdk.BenefitPublic(\n id=\"\",\n created_at=parse_datetime(\"2024-02-20T20:34:14.140Z\"),\n modified_at=None,\n type=polar_sdk.BenefitType.FEATURE_FLAG,\n description=\"yawn sharply inside ah lest who into\",\n selectable=False,\n deletable=False,\n organization_id=\"\",\n ),\n ],\n medias=[],\n ),\n ],\n product=polar_sdk.CheckoutProduct(\n id=\"\",\n created_at=parse_datetime(\"2025-07-25T20:35:56.555Z\"),\n modified_at=parse_datetime(\"2025-07-29T02:50:59.712Z\"),\n trial_interval=polar_sdk.TrialInterval.WEEK,\n trial_interval_count=272557,\n name=\"\",\n description=None,\n visibility=polar_sdk.ProductVisibility.DRAFT,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n recurring_interval_count=None,\n is_recurring=False,\n is_archived=True,\n organization_id=\"\",\n prices=[\n polar_sdk.LegacyRecurringProductPriceCustom(\n created_at=parse_datetime(\"2026-12-31T01:02:14.398Z\"),\n modified_at=parse_datetime(\"2025-02-10T09:37:50.330Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n tax_behavior=polar_sdk.TaxBehaviorOption.INCLUSIVE,\n is_archived=False,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,\n minimum_amount=109251,\n maximum_amount=453008,\n preset_amount=993489,\n ),\n ],\n benefits=[],\n medias=[],\n ),\n product_price=polar_sdk.LegacyRecurringProductPriceFree(\n created_at=parse_datetime(\"2024-01-09T23:11:23.326Z\"),\n modified_at=parse_datetime(\"2026-07-14T04:50:58.042Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.CATALOG,\n price_currency=\"\",\n tax_behavior=polar_sdk.TaxBehaviorOption.EXCLUSIVE,\n is_archived=True,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n ),\n prices={\n \"key\": [\n polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2025-05-21T11:44:28.596Z\"),\n modified_at=parse_datetime(\"2025-12-31T09:01:33.520Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n tax_behavior=polar_sdk.TaxBehaviorOption.INCLUSIVE,\n is_archived=False,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.WEEK,\n price_amount=334062,\n ),\n ],\n \"key1\": [],\n },\n discount=None,\n subscription_id=\"\",\n attached_custom_fields=[\n polar_sdk.AttachedCustomField(\n custom_field_id=\"\",\n custom_field=polar_sdk.CustomFieldNumber(\n created_at=parse_datetime(\"2026-03-05T08:28:23.107Z\"),\n modified_at=parse_datetime(\"2024-03-15T08:22:06.793Z\"),\n id=\"\",\n metadata={\n \"key\": 561911,\n },\n slug=\"\",\n name=\"\",\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n properties=polar_sdk.CustomFieldNumberProperties(),\n ),\n order=171811,\n required=False,\n ),\n ],\n customer_metadata={\n\n },\n ),\n ))\n\n # Handle response\n print(res)" - target: $["paths"]["checkout.updated"]["post"] update: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointcheckout_updated_post(request=polar_sdk.WebhookCheckoutUpdatedPayload(\n timestamp=parse_datetime(\"2024-03-18T05:40:46.816Z\"),\n data=polar_sdk.Checkout(\n id=\"\",\n created_at=parse_datetime(\"2025-09-17T13:52:37.257Z\"),\n modified_at=parse_datetime(\"2025-11-07T08:23:01.152Z\"),\n payment_processor=polar_sdk.PaymentProcessor.STRIPE,\n status=polar_sdk.CheckoutStatus.EXPIRED,\n client_secret=\"\",\n url=\"https://male-punctuation.name\",\n expires_at=parse_datetime(\"2026-03-26T06:13:51.386Z\"),\n success_url=\"https://monumental-mathematics.info\",\n return_url=\"https://scary-valley.com/\",\n embed_origin=\"\",\n amount=867510,\n discount_amount=469340,\n net_amount=139232,\n tax_amount=373760,\n total_amount=41301,\n currency=\"Azerbaijanian Manat\",\n allow_trial=True,\n active_trial_interval=None,\n active_trial_interval_count=669303,\n trial_end=parse_datetime(\"2026-01-10T10:00:41.343Z\"),\n organization_id=\"\",\n product_id=\"\",\n product_price_id=\"\",\n discount_id=\"\",\n allow_discount_codes=True,\n require_billing_address=False,\n is_discount_applicable=False,\n is_free_product_price=False,\n is_payment_required=True,\n is_payment_setup_required=True,\n is_payment_form_required=True,\n customer_id=\"\",\n is_business_customer=False,\n customer_name=\"\",\n customer_email=\"\",\n customer_ip_address=\"\",\n customer_billing_name=\"\",\n customer_billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n customer_tax_id=\"\",\n payment_processor_metadata={\n \"key\": \"\",\n \"key1\": \"\",\n \"key2\": \"\",\n },\n billing_address_fields=polar_sdk.CheckoutBillingAddressFields(\n country=polar_sdk.BillingAddressFieldMode.DISABLED,\n state=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n city=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n postal_code=polar_sdk.BillingAddressFieldMode.REQUIRED,\n line1=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n line2=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n ),\n trial_interval=polar_sdk.TrialInterval.YEAR,\n trial_interval_count=591735,\n metadata={\n\n },\n external_customer_id=\"\",\n products=[],\n product=polar_sdk.CheckoutProduct(\n id=\"\",\n created_at=parse_datetime(\"2024-06-20T05:48:31.398Z\"),\n modified_at=parse_datetime(\"2025-09-06T09:34:57.464Z\"),\n trial_interval=polar_sdk.TrialInterval.DAY,\n trial_interval_count=868555,\n name=\"\",\n description=\"tempting by or hippodrome mountain strict militate soupy partially simple\",\n visibility=polar_sdk.ProductVisibility.PUBLIC,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,\n recurring_interval_count=198497,\n is_recurring=True,\n is_archived=True,\n organization_id=\"\",\n prices=[\n polar_sdk.LegacyRecurringProductPriceFree(\n created_at=parse_datetime(\"2026-11-22T22:06:43.546Z\"),\n modified_at=parse_datetime(\"2024-12-18T01:07:08.468Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n is_archived=True,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.YEAR,\n ),\n ],\n benefits=[],\n medias=[],\n ),\n product_price=polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2024-09-16T18:07:01.178Z\"),\n modified_at=parse_datetime(\"2026-10-29T18:45:11.623Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n is_archived=False,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,\n price_amount=751316,\n ),\n prices={\n \"key\": [\n polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2025-07-23T20:15:20.077Z\"),\n modified_at=parse_datetime(\"2024-06-11T16:20:09.266Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.CATALOG,\n price_currency=\"\",\n is_archived=True,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n price_amount=320758,\n ),\n ],\n \"key1\": [\n polar_sdk.LegacyRecurringProductPriceCustom(\n created_at=parse_datetime(\"2026-05-18T01:17:33.749Z\"),\n modified_at=parse_datetime(\"2024-09-25T00:20:09.855Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n is_archived=False,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,\n minimum_amount=541141,\n maximum_amount=510330,\n preset_amount=995294,\n ),\n ],\n \"key2\": [\n polar_sdk.LegacyRecurringProductPriceFree(\n created_at=parse_datetime(\"2026-02-15T06:08:47.609Z\"),\n modified_at=parse_datetime(\"2026-11-15T09:06:30.844Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.CATALOG,\n price_currency=\"\",\n is_archived=True,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,\n ),\n ],\n },\n discount=polar_sdk.CheckoutDiscountPercentageOnceForeverDuration(\n duration=polar_sdk.DiscountDuration.ONCE,\n type=polar_sdk.DiscountType.FIXED,\n basis_points=1000,\n id=\"\",\n name=\"\",\n code=\"\",\n ),\n subscription_id=\"\",\n attached_custom_fields=[],\n customer_metadata={\n \"key\": \"\",\n },\n ),\n ))\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointcheckout_updated_post(request=polar_sdk.WebhookCheckoutUpdatedPayload(\n timestamp=parse_datetime(\"2024-03-18T05:40:46.816Z\"),\n data=polar_sdk.Checkout(\n id=\"\",\n created_at=parse_datetime(\"2025-09-17T13:52:37.257Z\"),\n modified_at=parse_datetime(\"2025-11-07T08:23:01.152Z\"),\n payment_processor=polar_sdk.PaymentProcessor.STRIPE,\n status=polar_sdk.CheckoutStatus.EXPIRED,\n client_secret=\"\",\n url=\"https://male-punctuation.name\",\n expires_at=parse_datetime(\"2026-03-26T06:13:51.386Z\"),\n success_url=\"https://monumental-mathematics.info\",\n return_url=\"https://scary-valley.com/\",\n embed_origin=\"\",\n amount=867510,\n discount_amount=469340,\n net_amount=139232,\n tax_amount=373760,\n total_amount=41301,\n currency=\"Azerbaijanian Manat\",\n allow_trial=True,\n active_trial_interval=None,\n active_trial_interval_count=669303,\n trial_end=parse_datetime(\"2026-01-10T10:00:41.343Z\"),\n organization_id=\"\",\n product_id=\"\",\n product_price_id=\"\",\n discount_id=\"\",\n allow_discount_codes=True,\n require_billing_address=False,\n is_discount_applicable=False,\n is_free_product_price=False,\n is_payment_required=True,\n is_payment_setup_required=True,\n is_payment_form_required=True,\n customer_id=\"\",\n is_business_customer=False,\n customer_name=\"\",\n customer_email=\"\",\n customer_ip_address=\"\",\n customer_billing_name=\"\",\n customer_billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n customer_tax_id=\"\",\n payment_processor_metadata={\n \"key\": \"\",\n \"key1\": \"\",\n \"key2\": \"\",\n },\n billing_address_fields=polar_sdk.CheckoutBillingAddressFields(\n country=polar_sdk.BillingAddressFieldMode.DISABLED,\n state=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n city=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n postal_code=polar_sdk.BillingAddressFieldMode.REQUIRED,\n line1=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n line2=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n ),\n trial_interval=polar_sdk.TrialInterval.YEAR,\n trial_interval_count=591735,\n metadata={\n\n },\n external_customer_id=\"\",\n products=[],\n product=polar_sdk.CheckoutProduct(\n id=\"\",\n created_at=parse_datetime(\"2024-06-20T05:48:31.398Z\"),\n modified_at=parse_datetime(\"2025-09-06T09:34:57.464Z\"),\n trial_interval=polar_sdk.TrialInterval.DAY,\n trial_interval_count=868555,\n name=\"\",\n description=\"tempting by or hippodrome mountain strict militate soupy partially simple\",\n visibility=polar_sdk.ProductVisibility.PUBLIC,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,\n recurring_interval_count=198497,\n is_recurring=True,\n is_archived=True,\n organization_id=\"\",\n prices=[\n polar_sdk.LegacyRecurringProductPriceFree(\n created_at=parse_datetime(\"2026-11-22T22:06:43.546Z\"),\n modified_at=parse_datetime(\"2024-12-18T01:07:08.468Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n tax_behavior=polar_sdk.TaxBehaviorOption.EXCLUSIVE,\n is_archived=True,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.WEEK,\n ),\n ],\n benefits=[\n polar_sdk.BenefitPublic(\n id=\"\",\n created_at=parse_datetime(\"2024-03-29T14:25:34.360Z\"),\n modified_at=parse_datetime(\"2024-09-16T18:07:01.178Z\"),\n type=polar_sdk.BenefitType.GITHUB_REPOSITORY,\n description=\"over beyond athwart youthful greedy eyeliner ouch faithfully kindly furthermore\",\n selectable=False,\n deletable=False,\n organization_id=\"\",\n ),\n ],\n medias=[],\n ),\n product_price=polar_sdk.LegacyRecurringProductPriceFree(\n created_at=parse_datetime(\"2026-03-22T07:52:36.730Z\"),\n modified_at=None,\n id=\"\",\n source=polar_sdk.ProductPriceSource.CATALOG,\n price_currency=\"\",\n tax_behavior=polar_sdk.TaxBehaviorOption.INCLUSIVE,\n is_archived=True,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n ),\n prices={\n\n },\n discount=polar_sdk.CheckoutDiscountFixedRepeatDuration(\n duration=polar_sdk.DiscountDuration.ONCE,\n duration_in_months=289680,\n type=polar_sdk.DiscountType.FIXED,\n amount=1000,\n currency=\"usd\",\n amounts={\n \"eur\": 900,\n \"usd\": 1000,\n },\n id=\"\",\n name=\"\",\n code=\"\",\n ),\n subscription_id=\"\",\n attached_custom_fields=[],\n customer_metadata={\n\n },\n ),\n ))\n\n # Handle response\n print(res)" - target: $["paths"]["customer.created"]["post"] update: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointcustomer_created_post(request={\n \"type\": \"customer.created\",\n \"timestamp\": parse_datetime(\"2026-10-24T17:37:29.711Z\"),\n \"data\": {\n \"id\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n \"created_at\": parse_datetime(\"2026-03-08T02:57:16.205Z\"),\n \"modified_at\": parse_datetime(\"2025-10-31T06:26:45.555Z\"),\n \"metadata\": {\n\n },\n \"external_id\": \"usr_1337\",\n \"email\": \"customer@example.com\",\n \"email_verified\": True,\n \"type\": polar_sdk.CustomerType.INDIVIDUAL,\n \"name\": \"John Doe\",\n \"billing_address\": {\n \"country\": polar_sdk.CountryAlpha2.US,\n },\n \"tax_id\": [\n \"911144442\",\n \"us_ein\",\n ],\n \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n \"deleted_at\": parse_datetime(\"2024-03-23T20:28:46.681Z\"),\n \"avatar_url\": \"https://www.gravatar.com/avatar/xxx?d=404\",\n },\n })\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointcustomer_created_post(request={\n \"type\": \"customer.created\",\n \"timestamp\": parse_datetime(\"2026-10-24T17:37:29.711Z\"),\n \"data\": {\n \"id\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n \"created_at\": parse_datetime(\"2026-03-08T02:57:16.205Z\"),\n \"modified_at\": parse_datetime(\"2025-10-31T06:26:45.555Z\"),\n \"metadata\": {\n\n },\n \"external_id\": \"usr_1337\",\n \"email\": \"customer@example.com\",\n \"email_verified\": True,\n \"type\": polar_sdk.CustomerType.INDIVIDUAL,\n \"name\": \"John Doe\",\n \"billing_address\": {\n \"country\": polar_sdk.AddressCountryAlpha2.US,\n },\n \"tax_id\": [\n \"911144442\",\n \"us_ein\",\n ],\n \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n \"deleted_at\": parse_datetime(\"2024-03-23T20:28:46.681Z\"),\n \"avatar_url\": \"https://www.gravatar.com/avatar/xxx?d=404\",\n },\n })\n\n # Handle response\n print(res)" - target: $["paths"]["customer.deleted"]["post"] update: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointcustomer_deleted_post(request={\n \"type\": \"customer.deleted\",\n \"timestamp\": parse_datetime(\"2024-07-11T21:40:34.752Z\"),\n \"data\": {\n \"id\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n \"created_at\": parse_datetime(\"2026-12-23T11:32:42.100Z\"),\n \"modified_at\": parse_datetime(\"2024-07-08T17:16:24.833Z\"),\n \"metadata\": {\n\n },\n \"external_id\": \"usr_1337\",\n \"email\": \"customer@example.com\",\n \"email_verified\": True,\n \"type\": polar_sdk.CustomerType.INDIVIDUAL,\n \"name\": \"John Doe\",\n \"billing_address\": {\n \"country\": polar_sdk.CountryAlpha2.US,\n },\n \"tax_id\": [\n \"911144442\",\n \"us_ein\",\n ],\n \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n \"deleted_at\": parse_datetime(\"2024-09-29T09:04:17.770Z\"),\n \"avatar_url\": \"https://www.gravatar.com/avatar/xxx?d=404\",\n },\n })\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointcustomer_deleted_post(request={\n \"type\": \"customer.deleted\",\n \"timestamp\": parse_datetime(\"2024-07-11T21:40:34.752Z\"),\n \"data\": {\n \"id\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n \"created_at\": parse_datetime(\"2026-12-23T11:32:42.100Z\"),\n \"modified_at\": parse_datetime(\"2024-07-08T17:16:24.833Z\"),\n \"metadata\": {\n\n },\n \"external_id\": \"usr_1337\",\n \"email\": \"customer@example.com\",\n \"email_verified\": True,\n \"type\": polar_sdk.CustomerType.INDIVIDUAL,\n \"name\": \"John Doe\",\n \"billing_address\": {\n \"country\": polar_sdk.AddressCountryAlpha2.US,\n },\n \"tax_id\": [\n \"911144442\",\n \"us_ein\",\n ],\n \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n \"deleted_at\": parse_datetime(\"2024-09-29T09:04:17.770Z\"),\n \"avatar_url\": \"https://www.gravatar.com/avatar/xxx?d=404\",\n },\n })\n\n # Handle response\n print(res)" - target: $["paths"]["customer.state_changed"]["post"] update: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointcustomer_state_changed_post(request={\n \"type\": \"customer.state_changed\",\n \"timestamp\": parse_datetime(\"2026-05-22T16:03:32.369Z\"),\n \"data\": {\n \"id\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n \"created_at\": parse_datetime(\"2024-07-24T20:57:42.542Z\"),\n \"modified_at\": None,\n \"metadata\": {\n\n },\n \"external_id\": \"usr_1337\",\n \"email\": \"customer@example.com\",\n \"email_verified\": True,\n \"type\": polar_sdk.CustomerType.INDIVIDUAL,\n \"name\": \"John Doe\",\n \"billing_address\": {\n \"country\": polar_sdk.CountryAlpha2.US,\n },\n \"tax_id\": [\n \"911144442\",\n \"us_ein\",\n ],\n \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n \"deleted_at\": parse_datetime(\"2026-09-08T18:19:10.187Z\"),\n \"active_subscriptions\": [],\n \"granted_benefits\": [\n {\n \"id\": \"d322132c-a9d0-4e0d-b8d3-d81ad021a3a9\",\n \"created_at\": parse_datetime(\"2026-09-01T02:21:29.525Z\"),\n \"modified_at\": parse_datetime(\"2024-11-11T17:51:37.646Z\"),\n \"granted_at\": parse_datetime(\"2025-01-03T13:37:00Z\"),\n \"benefit_id\": \"397a17aa-15cf-4cb4-9333-18040203cf98\",\n \"benefit_type\": polar_sdk.BenefitType.METER_CREDIT,\n \"benefit_metadata\": {\n\n },\n \"properties\": {},\n },\n ],\n \"active_meters\": [],\n \"avatar_url\": \"https://www.gravatar.com/avatar/xxx?d=404\",\n },\n })\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointcustomer_state_changed_post(request={\n \"type\": \"customer.state_changed\",\n \"timestamp\": parse_datetime(\"2026-05-22T16:03:32.369Z\"),\n \"data\": {\n \"id\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n \"created_at\": parse_datetime(\"2024-07-24T20:57:42.542Z\"),\n \"modified_at\": None,\n \"metadata\": {\n\n },\n \"external_id\": \"usr_1337\",\n \"email\": \"customer@example.com\",\n \"email_verified\": True,\n \"type\": polar_sdk.CustomerType.INDIVIDUAL,\n \"name\": \"John Doe\",\n \"billing_address\": {\n \"country\": polar_sdk.AddressCountryAlpha2.US,\n },\n \"tax_id\": [\n \"911144442\",\n \"us_ein\",\n ],\n \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n \"deleted_at\": parse_datetime(\"2026-09-08T18:19:10.187Z\"),\n \"active_subscriptions\": [],\n \"granted_benefits\": [\n {\n \"id\": \"d322132c-a9d0-4e0d-b8d3-d81ad021a3a9\",\n \"created_at\": parse_datetime(\"2026-09-01T02:21:29.525Z\"),\n \"modified_at\": parse_datetime(\"2024-11-11T17:51:37.646Z\"),\n \"granted_at\": parse_datetime(\"2025-01-03T13:37:00Z\"),\n \"benefit_id\": \"397a17aa-15cf-4cb4-9333-18040203cf98\",\n \"benefit_type\": polar_sdk.BenefitType.METER_CREDIT,\n \"benefit_metadata\": {\n\n },\n \"properties\": {},\n },\n ],\n \"active_meters\": [],\n \"avatar_url\": \"https://www.gravatar.com/avatar/xxx?d=404\",\n },\n })\n\n # Handle response\n print(res)" - target: $["paths"]["customer.updated"]["post"] update: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointcustomer_updated_post(request={\n \"type\": \"customer.updated\",\n \"timestamp\": parse_datetime(\"2024-07-08T20:22:33.716Z\"),\n \"data\": {\n \"id\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n \"created_at\": parse_datetime(\"2025-07-18T23:25:12.977Z\"),\n \"modified_at\": parse_datetime(\"2024-04-06T04:58:11.725Z\"),\n \"metadata\": {\n \"key\": 983601,\n },\n \"external_id\": \"usr_1337\",\n \"email\": \"customer@example.com\",\n \"email_verified\": True,\n \"type\": polar_sdk.CustomerType.INDIVIDUAL,\n \"name\": \"John Doe\",\n \"billing_address\": {\n \"country\": polar_sdk.CountryAlpha2.US,\n },\n \"tax_id\": [\n \"911144442\",\n \"us_ein\",\n ],\n \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n \"deleted_at\": parse_datetime(\"2026-01-11T12:43:11.694Z\"),\n \"avatar_url\": \"https://www.gravatar.com/avatar/xxx?d=404\",\n },\n })\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointcustomer_updated_post(request={\n \"type\": \"customer.updated\",\n \"timestamp\": parse_datetime(\"2024-07-08T20:22:33.716Z\"),\n \"data\": {\n \"id\": \"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n \"created_at\": parse_datetime(\"2025-07-18T23:25:12.977Z\"),\n \"modified_at\": parse_datetime(\"2024-04-06T04:58:11.725Z\"),\n \"metadata\": {\n \"key\": 983601,\n },\n \"external_id\": \"usr_1337\",\n \"email\": \"customer@example.com\",\n \"email_verified\": True,\n \"type\": polar_sdk.CustomerType.INDIVIDUAL,\n \"name\": \"John Doe\",\n \"billing_address\": {\n \"country\": polar_sdk.AddressCountryAlpha2.US,\n },\n \"tax_id\": [\n \"911144442\",\n \"us_ein\",\n ],\n \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n \"deleted_at\": parse_datetime(\"2026-01-11T12:43:11.694Z\"),\n \"avatar_url\": \"https://www.gravatar.com/avatar/xxx?d=404\",\n },\n })\n\n # Handle response\n print(res)" - target: $["paths"]["customer_seat.assigned"]["post"] update: "x-codeSamples": @@ -1136,43 +1136,43 @@ actions: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointorder_created_post(request=polar_sdk.WebhookOrderCreatedPayload(\n timestamp=parse_datetime(\"2025-08-21T06:55:49.348Z\"),\n data=polar_sdk.Order(\n id=\"\",\n created_at=parse_datetime(\"2024-01-02T23:31:01.991Z\"),\n modified_at=parse_datetime(\"2026-11-09T23:45:36.352Z\"),\n status=polar_sdk.OrderStatus.PENDING,\n paid=True,\n subtotal_amount=10000,\n discount_amount=1000,\n net_amount=9000,\n tax_amount=720,\n total_amount=9720,\n applied_balance_amount=0,\n due_amount=0,\n refunded_amount=0,\n refunded_tax_amount=0,\n currency=\"usd\",\n billing_reason=polar_sdk.OrderBillingReason.PURCHASE,\n billing_name=\"\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n invoice_number=\"\",\n is_invoice_generated=False,\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n subscription_id=\"\",\n checkout_id=\"\",\n metadata={\n \"key\": \"\",\n },\n platform_fee_amount=500,\n platform_fee_currency=\"usd\",\n customer=polar_sdk.OrderCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2026-08-09T17:02:40.706Z\"),\n modified_at=parse_datetime(\"2026-10-06T19:34:47.732Z\"),\n metadata={\n \"key\": 701529,\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=None,\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=polar_sdk.OrderProduct(\n metadata={\n\n },\n id=\"\",\n created_at=parse_datetime(\"2026-06-03T19:46:15.179Z\"),\n modified_at=parse_datetime(\"2024-10-20T21:28:56.316Z\"),\n trial_interval=polar_sdk.TrialInterval.WEEK,\n trial_interval_count=271259,\n name=\"\",\n description=\"gadzooks trek amid misspend ravioli supposing bare pfft\",\n visibility=polar_sdk.ProductVisibility.PUBLIC,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n recurring_interval_count=211748,\n is_recurring=True,\n is_archived=True,\n organization_id=\"\",\n ),\n discount=polar_sdk.DiscountFixedRepeatDurationBase(\n duration=polar_sdk.DiscountDuration.ONCE,\n duration_in_months=865488,\n type=polar_sdk.DiscountType.FIXED,\n amount=1000,\n currency=\"usd\",\n amounts={\n \"eur\": 900,\n \"usd\": 1000,\n },\n created_at=parse_datetime(\"2024-08-03T14:24:05.390Z\"),\n modified_at=parse_datetime(\"2024-01-25T10:47:26.689Z\"),\n id=\"\",\n metadata={\n\n },\n name=\"\",\n code=\"\",\n starts_at=None,\n ends_at=parse_datetime(\"2025-02-06T05:20:48.151Z\"),\n max_redemptions=200286,\n redemptions_count=148325,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n subscription=None,\n items=[\n polar_sdk.OrderItemSchema(\n created_at=parse_datetime(\"2025-01-03T15:31:18.185Z\"),\n modified_at=parse_datetime(\"2024-12-09T13:26:22.287Z\"),\n id=\"\",\n label=\"Pro Plan\",\n amount=10000,\n tax_amount=720,\n proration=False,\n product_price_id=\"\",\n ),\n ],\n description=\"Pro Plan\",\n ),\n ))\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointorder_created_post(request=polar_sdk.WebhookOrderCreatedPayload(\n timestamp=parse_datetime(\"2025-08-21T06:55:49.348Z\"),\n data=polar_sdk.Order(\n id=\"\",\n created_at=parse_datetime(\"2024-01-02T23:31:01.991Z\"),\n modified_at=parse_datetime(\"2026-11-09T23:45:36.352Z\"),\n status=polar_sdk.OrderStatus.PENDING,\n paid=True,\n subtotal_amount=10000,\n discount_amount=1000,\n net_amount=9000,\n tax_amount=720,\n total_amount=9720,\n applied_balance_amount=0,\n due_amount=0,\n refunded_amount=0,\n refunded_tax_amount=0,\n currency=\"usd\",\n billing_reason=polar_sdk.OrderBillingReason.PURCHASE,\n billing_name=\"\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n invoice_number=\"\",\n is_invoice_generated=False,\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n subscription_id=\"\",\n checkout_id=\"\",\n metadata={\n \"key\": \"\",\n },\n platform_fee_amount=500,\n platform_fee_currency=\"usd\",\n customer=polar_sdk.OrderCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2026-08-09T17:02:40.706Z\"),\n modified_at=parse_datetime(\"2026-10-06T19:34:47.732Z\"),\n metadata={\n \"key\": 701529,\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=None,\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=polar_sdk.OrderProduct(\n metadata={\n\n },\n id=\"\",\n created_at=parse_datetime(\"2026-06-03T19:46:15.179Z\"),\n modified_at=parse_datetime(\"2024-10-20T21:28:56.316Z\"),\n trial_interval=polar_sdk.TrialInterval.WEEK,\n trial_interval_count=271259,\n name=\"\",\n description=\"gadzooks trek amid misspend ravioli supposing bare pfft\",\n visibility=polar_sdk.ProductVisibility.PUBLIC,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n recurring_interval_count=211748,\n is_recurring=True,\n is_archived=True,\n organization_id=\"\",\n ),\n discount=polar_sdk.DiscountFixedRepeatDurationBase(\n duration=polar_sdk.DiscountDuration.ONCE,\n duration_in_months=865488,\n type=polar_sdk.DiscountType.FIXED,\n amount=1000,\n currency=\"usd\",\n amounts={\n \"eur\": 900,\n \"usd\": 1000,\n },\n created_at=parse_datetime(\"2024-08-03T14:24:05.390Z\"),\n modified_at=parse_datetime(\"2024-01-25T10:47:26.689Z\"),\n id=\"\",\n metadata={\n\n },\n name=\"\",\n code=\"\",\n starts_at=None,\n ends_at=parse_datetime(\"2025-02-06T05:20:48.151Z\"),\n max_redemptions=200286,\n redemptions_count=148325,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n subscription=None,\n items=[\n polar_sdk.OrderItemSchema(\n created_at=parse_datetime(\"2025-01-03T15:31:18.185Z\"),\n modified_at=parse_datetime(\"2024-12-09T13:26:22.287Z\"),\n id=\"\",\n label=\"Pro Plan\",\n amount=10000,\n tax_amount=720,\n proration=False,\n product_price_id=\"\",\n ),\n ],\n description=\"Pro Plan\",\n ),\n ))\n\n # Handle response\n print(res)" - target: $["paths"]["order.paid"]["post"] update: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointorder_paid_post(request=polar_sdk.WebhookOrderPaidPayload(\n timestamp=parse_datetime(\"2026-12-05T07:44:21.172Z\"),\n data=polar_sdk.Order(\n id=\"\",\n created_at=parse_datetime(\"2026-07-27T09:45:49.517Z\"),\n modified_at=parse_datetime(\"2025-12-13T20:55:19.644Z\"),\n status=polar_sdk.OrderStatus.VOID,\n paid=True,\n subtotal_amount=10000,\n discount_amount=1000,\n net_amount=9000,\n tax_amount=720,\n total_amount=9720,\n applied_balance_amount=0,\n due_amount=0,\n refunded_amount=0,\n refunded_tax_amount=0,\n currency=\"usd\",\n billing_reason=polar_sdk.OrderBillingReason.SUBSCRIPTION_UPDATE,\n billing_name=\"\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n invoice_number=\"\",\n is_invoice_generated=True,\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n subscription_id=\"\",\n checkout_id=\"\",\n metadata={\n\n },\n platform_fee_amount=500,\n platform_fee_currency=\"usd\",\n customer=polar_sdk.OrderCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2026-08-31T00:54:53.749Z\"),\n modified_at=parse_datetime(\"2026-07-24T12:09:26.716Z\"),\n metadata={\n \"key\": \"\",\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2026-04-20T14:41:24.727Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=polar_sdk.OrderProduct(\n metadata={\n\n },\n id=\"\",\n created_at=parse_datetime(\"2024-06-17T22:24:34.935Z\"),\n modified_at=parse_datetime(\"2026-08-01T03:33:20.782Z\"),\n trial_interval=polar_sdk.TrialInterval.WEEK,\n trial_interval_count=125374,\n name=\"\",\n description=\"easily carouse plus quietly reservation bright injunction plastic gah\",\n visibility=polar_sdk.ProductVisibility.PUBLIC,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.WEEK,\n recurring_interval_count=417172,\n is_recurring=True,\n is_archived=False,\n organization_id=\"\",\n ),\n discount=polar_sdk.DiscountPercentageOnceForeverDurationBase(\n duration=polar_sdk.DiscountDuration.FOREVER,\n type=polar_sdk.DiscountType.PERCENTAGE,\n basis_points=1000,\n created_at=parse_datetime(\"2025-05-24T21:01:40.292Z\"),\n modified_at=parse_datetime(\"2025-05-25T21:22:06.978Z\"),\n id=\"\",\n metadata={\n\n },\n name=\"\",\n code=\"\",\n starts_at=parse_datetime(\"2025-09-14T19:23:38.365Z\"),\n ends_at=parse_datetime(\"2025-10-02T13:51:42.523Z\"),\n max_redemptions=231748,\n redemptions_count=846855,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n subscription=polar_sdk.OrderSubscription(\n metadata={\n \"key\": 5251.57,\n },\n created_at=parse_datetime(\"2026-02-12T23:41:13.290Z\"),\n modified_at=parse_datetime(\"2024-02-24T15:15:22.018Z\"),\n id=\"\",\n amount=10000,\n currency=\"usd\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.WEEK,\n recurring_interval_count=310795,\n status=polar_sdk.SubscriptionStatus.CANCELED,\n current_period_start=parse_datetime(\"2024-11-19T10:20:23.628Z\"),\n current_period_end=parse_datetime(\"2024-06-30T03:36:16.430Z\"),\n trial_start=parse_datetime(\"2025-09-21T14:56:16.106Z\"),\n trial_end=parse_datetime(\"2024-01-21T03:35:38.158Z\"),\n cancel_at_period_end=False,\n canceled_at=parse_datetime(\"2024-08-07T23:25:37.197Z\"),\n started_at=parse_datetime(\"2025-10-04T00:59:57.339Z\"),\n ends_at=parse_datetime(\"2026-02-01T22:39:43.609Z\"),\n ended_at=parse_datetime(\"2024-08-03T10:17:52.706Z\"),\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n checkout_id=\"\",\n customer_cancellation_reason=None,\n customer_cancellation_comment=\"\",\n ),\n items=[],\n description=\"Pro Plan\",\n ),\n ))\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointorder_paid_post(request=polar_sdk.WebhookOrderPaidPayload(\n timestamp=parse_datetime(\"2026-12-05T07:44:21.172Z\"),\n data=polar_sdk.Order(\n id=\"\",\n created_at=parse_datetime(\"2026-07-27T09:45:49.517Z\"),\n modified_at=parse_datetime(\"2025-12-13T20:55:19.644Z\"),\n status=polar_sdk.OrderStatus.VOID,\n paid=True,\n subtotal_amount=10000,\n discount_amount=1000,\n net_amount=9000,\n tax_amount=720,\n total_amount=9720,\n applied_balance_amount=0,\n due_amount=0,\n refunded_amount=0,\n refunded_tax_amount=0,\n currency=\"usd\",\n billing_reason=polar_sdk.OrderBillingReason.SUBSCRIPTION_UPDATE,\n billing_name=\"\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n invoice_number=\"\",\n is_invoice_generated=True,\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n subscription_id=\"\",\n checkout_id=\"\",\n metadata={\n\n },\n platform_fee_amount=500,\n platform_fee_currency=\"usd\",\n customer=polar_sdk.OrderCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2026-08-31T00:54:53.749Z\"),\n modified_at=parse_datetime(\"2026-07-24T12:09:26.716Z\"),\n metadata={\n \"key\": \"\",\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2026-04-20T14:41:24.727Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=polar_sdk.OrderProduct(\n metadata={\n\n },\n id=\"\",\n created_at=parse_datetime(\"2024-06-17T22:24:34.935Z\"),\n modified_at=parse_datetime(\"2026-08-01T03:33:20.782Z\"),\n trial_interval=polar_sdk.TrialInterval.WEEK,\n trial_interval_count=125374,\n name=\"\",\n description=\"easily carouse plus quietly reservation bright injunction plastic gah\",\n visibility=polar_sdk.ProductVisibility.PUBLIC,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.WEEK,\n recurring_interval_count=417172,\n is_recurring=True,\n is_archived=False,\n organization_id=\"\",\n ),\n discount=polar_sdk.DiscountPercentageOnceForeverDurationBase(\n duration=polar_sdk.DiscountDuration.FOREVER,\n type=polar_sdk.DiscountType.PERCENTAGE,\n basis_points=1000,\n created_at=parse_datetime(\"2025-05-24T21:01:40.292Z\"),\n modified_at=parse_datetime(\"2025-05-25T21:22:06.978Z\"),\n id=\"\",\n metadata={\n\n },\n name=\"\",\n code=\"\",\n starts_at=parse_datetime(\"2025-09-14T19:23:38.365Z\"),\n ends_at=parse_datetime(\"2025-10-02T13:51:42.523Z\"),\n max_redemptions=231748,\n redemptions_count=846855,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n subscription=polar_sdk.OrderSubscription(\n metadata={\n \"key\": 5251.57,\n },\n created_at=parse_datetime(\"2026-02-12T23:41:13.290Z\"),\n modified_at=parse_datetime(\"2024-02-24T15:15:22.018Z\"),\n id=\"\",\n amount=10000,\n currency=\"usd\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.WEEK,\n recurring_interval_count=310795,\n status=polar_sdk.SubscriptionStatus.CANCELED,\n current_period_start=parse_datetime(\"2024-11-19T10:20:23.628Z\"),\n current_period_end=parse_datetime(\"2024-06-30T03:36:16.430Z\"),\n trial_start=parse_datetime(\"2025-09-21T14:56:16.106Z\"),\n trial_end=parse_datetime(\"2024-01-21T03:35:38.158Z\"),\n cancel_at_period_end=False,\n canceled_at=parse_datetime(\"2024-08-07T23:25:37.197Z\"),\n started_at=parse_datetime(\"2025-10-04T00:59:57.339Z\"),\n ends_at=parse_datetime(\"2026-02-01T22:39:43.609Z\"),\n ended_at=parse_datetime(\"2024-08-03T10:17:52.706Z\"),\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n checkout_id=\"\",\n customer_cancellation_reason=None,\n customer_cancellation_comment=\"\",\n ),\n items=[],\n description=\"Pro Plan\",\n ),\n ))\n\n # Handle response\n print(res)" - target: $["paths"]["order.refunded"]["post"] update: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointorder_refunded_post(request=polar_sdk.WebhookOrderRefundedPayload(\n timestamp=parse_datetime(\"2025-07-23T18:00:11.615Z\"),\n data=polar_sdk.Order(\n id=\"\",\n created_at=parse_datetime(\"2026-03-19T11:53:59.744Z\"),\n modified_at=parse_datetime(\"2025-12-01T04:03:14.906Z\"),\n status=polar_sdk.OrderStatus.PARTIALLY_REFUNDED,\n paid=True,\n subtotal_amount=10000,\n discount_amount=1000,\n net_amount=9000,\n tax_amount=720,\n total_amount=9720,\n applied_balance_amount=0,\n due_amount=0,\n refunded_amount=0,\n refunded_tax_amount=0,\n currency=\"usd\",\n billing_reason=polar_sdk.OrderBillingReason.SUBSCRIPTION_CREATE,\n billing_name=\"\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n invoice_number=\"\",\n is_invoice_generated=False,\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n subscription_id=\"\",\n checkout_id=\"\",\n metadata={\n\n },\n platform_fee_amount=500,\n platform_fee_currency=\"usd\",\n customer=polar_sdk.OrderCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2025-05-21T22:00:59.902Z\"),\n modified_at=parse_datetime(\"2025-08-24T07:48:58.778Z\"),\n metadata={\n \"key\": 647689,\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2025-08-19T02:54:30.835Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=None,\n discount=polar_sdk.DiscountFixedRepeatDurationBase(\n duration=polar_sdk.DiscountDuration.ONCE,\n duration_in_months=310259,\n type=polar_sdk.DiscountType.PERCENTAGE,\n amount=1000,\n currency=\"usd\",\n amounts={\n \"eur\": 900,\n \"usd\": 1000,\n },\n created_at=parse_datetime(\"2024-01-26T21:26:48.872Z\"),\n modified_at=parse_datetime(\"2024-01-16T07:26:04.196Z\"),\n id=\"\",\n metadata={\n \"key\": 4016.73,\n },\n name=\"\",\n code=\"\",\n starts_at=parse_datetime(\"2026-09-14T03:05:33.012Z\"),\n ends_at=None,\n max_redemptions=211875,\n redemptions_count=188354,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n subscription=None,\n items=[\n polar_sdk.OrderItemSchema(\n created_at=parse_datetime(\"2025-12-08T10:40:25.472Z\"),\n modified_at=parse_datetime(\"2024-12-19T17:19:16.701Z\"),\n id=\"\",\n label=\"Pro Plan\",\n amount=10000,\n tax_amount=720,\n proration=False,\n product_price_id=\"\",\n ),\n ],\n description=\"Pro Plan\",\n ),\n ))\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointorder_refunded_post(request=polar_sdk.WebhookOrderRefundedPayload(\n timestamp=parse_datetime(\"2025-07-23T18:00:11.615Z\"),\n data=polar_sdk.Order(\n id=\"\",\n created_at=parse_datetime(\"2026-03-19T11:53:59.744Z\"),\n modified_at=parse_datetime(\"2025-12-01T04:03:14.906Z\"),\n status=polar_sdk.OrderStatus.PARTIALLY_REFUNDED,\n paid=True,\n subtotal_amount=10000,\n discount_amount=1000,\n net_amount=9000,\n tax_amount=720,\n total_amount=9720,\n applied_balance_amount=0,\n due_amount=0,\n refunded_amount=0,\n refunded_tax_amount=0,\n currency=\"usd\",\n billing_reason=polar_sdk.OrderBillingReason.SUBSCRIPTION_CREATE,\n billing_name=\"\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n invoice_number=\"\",\n is_invoice_generated=False,\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n subscription_id=\"\",\n checkout_id=\"\",\n metadata={\n\n },\n platform_fee_amount=500,\n platform_fee_currency=\"usd\",\n customer=polar_sdk.OrderCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2025-05-21T22:00:59.902Z\"),\n modified_at=parse_datetime(\"2025-08-24T07:48:58.778Z\"),\n metadata={\n \"key\": 647689,\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2025-08-19T02:54:30.835Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=None,\n discount=polar_sdk.DiscountFixedRepeatDurationBase(\n duration=polar_sdk.DiscountDuration.ONCE,\n duration_in_months=310259,\n type=polar_sdk.DiscountType.PERCENTAGE,\n amount=1000,\n currency=\"usd\",\n amounts={\n \"eur\": 900,\n \"usd\": 1000,\n },\n created_at=parse_datetime(\"2024-01-26T21:26:48.872Z\"),\n modified_at=parse_datetime(\"2024-01-16T07:26:04.196Z\"),\n id=\"\",\n metadata={\n \"key\": 4016.73,\n },\n name=\"\",\n code=\"\",\n starts_at=parse_datetime(\"2026-09-14T03:05:33.012Z\"),\n ends_at=None,\n max_redemptions=211875,\n redemptions_count=188354,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n subscription=None,\n items=[\n polar_sdk.OrderItemSchema(\n created_at=parse_datetime(\"2025-12-08T10:40:25.472Z\"),\n modified_at=parse_datetime(\"2024-12-19T17:19:16.701Z\"),\n id=\"\",\n label=\"Pro Plan\",\n amount=10000,\n tax_amount=720,\n proration=False,\n product_price_id=\"\",\n ),\n ],\n description=\"Pro Plan\",\n ),\n ))\n\n # Handle response\n print(res)" - target: $["paths"]["order.updated"]["post"] update: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointorder_updated_post(request=polar_sdk.WebhookOrderUpdatedPayload(\n timestamp=parse_datetime(\"2024-10-24T00:08:50.290Z\"),\n data=polar_sdk.Order(\n id=\"\",\n created_at=parse_datetime(\"2025-04-30T23:35:35.375Z\"),\n modified_at=parse_datetime(\"2026-06-01T02:02:46.580Z\"),\n status=polar_sdk.OrderStatus.PENDING,\n paid=True,\n subtotal_amount=10000,\n discount_amount=1000,\n net_amount=9000,\n tax_amount=720,\n total_amount=9720,\n applied_balance_amount=0,\n due_amount=0,\n refunded_amount=0,\n refunded_tax_amount=0,\n currency=\"usd\",\n billing_reason=polar_sdk.OrderBillingReason.SUBSCRIPTION_CREATE,\n billing_name=\"\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n invoice_number=\"\",\n is_invoice_generated=True,\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n subscription_id=\"\",\n checkout_id=\"\",\n metadata={\n\n },\n platform_fee_amount=500,\n platform_fee_currency=\"usd\",\n customer=polar_sdk.OrderCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2024-12-13T17:38:07.808Z\"),\n modified_at=parse_datetime(\"2025-04-07T10:18:18.539Z\"),\n metadata={\n\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2025-10-23T02:39:12.424Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=polar_sdk.OrderProduct(\n metadata={\n\n },\n id=\"\",\n created_at=parse_datetime(\"2025-12-03T05:16:11.415Z\"),\n modified_at=parse_datetime(\"2024-03-10T05:58:05.184Z\"),\n trial_interval=None,\n trial_interval_count=None,\n name=\"\",\n description=\"simple eventually briskly considering\",\n visibility=polar_sdk.ProductVisibility.PUBLIC,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n recurring_interval_count=164584,\n is_recurring=False,\n is_archived=False,\n organization_id=\"\",\n ),\n discount=polar_sdk.DiscountPercentageRepeatDurationBase(\n duration=polar_sdk.DiscountDuration.FOREVER,\n duration_in_months=386185,\n type=polar_sdk.DiscountType.FIXED,\n basis_points=1000,\n created_at=parse_datetime(\"2024-09-30T05:16:42.046Z\"),\n modified_at=None,\n id=\"\",\n metadata={\n \"key\": 5522.84,\n },\n name=\"\",\n code=\"\",\n starts_at=None,\n ends_at=parse_datetime(\"2026-11-29T22:29:50.794Z\"),\n max_redemptions=87962,\n redemptions_count=617041,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n subscription=polar_sdk.OrderSubscription(\n metadata={\n\n },\n created_at=parse_datetime(\"2024-05-01T19:12:30.014Z\"),\n modified_at=parse_datetime(\"2025-05-12T23:36:17.099Z\"),\n id=\"\",\n amount=10000,\n currency=\"usd\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.YEAR,\n recurring_interval_count=71896,\n status=polar_sdk.SubscriptionStatus.UNPAID,\n current_period_start=parse_datetime(\"2024-05-04T04:27:56.002Z\"),\n current_period_end=parse_datetime(\"2024-04-09T21:27:35.876Z\"),\n trial_start=parse_datetime(\"2024-01-24T12:25:14.117Z\"),\n trial_end=parse_datetime(\"2024-12-27T18:30:07.396Z\"),\n cancel_at_period_end=True,\n canceled_at=parse_datetime(\"2024-08-31T14:56:03.459Z\"),\n started_at=parse_datetime(\"2025-10-01T02:03:16.161Z\"),\n ends_at=parse_datetime(\"2026-03-04T09:29:46.413Z\"),\n ended_at=parse_datetime(\"2026-11-15T17:24:36.671Z\"),\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n checkout_id=\"\",\n customer_cancellation_reason=polar_sdk.CustomerCancellationReason.UNUSED,\n customer_cancellation_comment=\"\",\n ),\n items=[\n polar_sdk.OrderItemSchema(\n created_at=parse_datetime(\"2025-03-12T02:07:55.904Z\"),\n modified_at=parse_datetime(\"2024-08-25T12:56:24.423Z\"),\n id=\"\",\n label=\"Pro Plan\",\n amount=10000,\n tax_amount=720,\n proration=False,\n product_price_id=\"\",\n ),\n ],\n description=\"Pro Plan\",\n ),\n ))\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointorder_updated_post(request=polar_sdk.WebhookOrderUpdatedPayload(\n timestamp=parse_datetime(\"2024-10-24T00:08:50.290Z\"),\n data=polar_sdk.Order(\n id=\"\",\n created_at=parse_datetime(\"2025-04-30T23:35:35.375Z\"),\n modified_at=parse_datetime(\"2026-06-01T02:02:46.580Z\"),\n status=polar_sdk.OrderStatus.PENDING,\n paid=True,\n subtotal_amount=10000,\n discount_amount=1000,\n net_amount=9000,\n tax_amount=720,\n total_amount=9720,\n applied_balance_amount=0,\n due_amount=0,\n refunded_amount=0,\n refunded_tax_amount=0,\n currency=\"usd\",\n billing_reason=polar_sdk.OrderBillingReason.SUBSCRIPTION_CREATE,\n billing_name=\"\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n invoice_number=\"\",\n is_invoice_generated=True,\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n subscription_id=\"\",\n checkout_id=\"\",\n metadata={\n\n },\n platform_fee_amount=500,\n platform_fee_currency=\"usd\",\n customer=polar_sdk.OrderCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2024-12-13T17:38:07.808Z\"),\n modified_at=parse_datetime(\"2025-04-07T10:18:18.539Z\"),\n metadata={\n\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2025-10-23T02:39:12.424Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=polar_sdk.OrderProduct(\n metadata={\n\n },\n id=\"\",\n created_at=parse_datetime(\"2025-12-03T05:16:11.415Z\"),\n modified_at=parse_datetime(\"2024-03-10T05:58:05.184Z\"),\n trial_interval=None,\n trial_interval_count=None,\n name=\"\",\n description=\"simple eventually briskly considering\",\n visibility=polar_sdk.ProductVisibility.PUBLIC,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n recurring_interval_count=164584,\n is_recurring=False,\n is_archived=False,\n organization_id=\"\",\n ),\n discount=polar_sdk.DiscountPercentageRepeatDurationBase(\n duration=polar_sdk.DiscountDuration.FOREVER,\n duration_in_months=386185,\n type=polar_sdk.DiscountType.FIXED,\n basis_points=1000,\n created_at=parse_datetime(\"2024-09-30T05:16:42.046Z\"),\n modified_at=None,\n id=\"\",\n metadata={\n \"key\": 5522.84,\n },\n name=\"\",\n code=\"\",\n starts_at=None,\n ends_at=parse_datetime(\"2026-11-29T22:29:50.794Z\"),\n max_redemptions=87962,\n redemptions_count=617041,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n subscription=polar_sdk.OrderSubscription(\n metadata={\n\n },\n created_at=parse_datetime(\"2024-05-01T19:12:30.014Z\"),\n modified_at=parse_datetime(\"2025-05-12T23:36:17.099Z\"),\n id=\"\",\n amount=10000,\n currency=\"usd\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.YEAR,\n recurring_interval_count=71896,\n status=polar_sdk.SubscriptionStatus.UNPAID,\n current_period_start=parse_datetime(\"2024-05-04T04:27:56.002Z\"),\n current_period_end=parse_datetime(\"2024-04-09T21:27:35.876Z\"),\n trial_start=parse_datetime(\"2024-01-24T12:25:14.117Z\"),\n trial_end=parse_datetime(\"2024-12-27T18:30:07.396Z\"),\n cancel_at_period_end=True,\n canceled_at=parse_datetime(\"2024-08-31T14:56:03.459Z\"),\n started_at=parse_datetime(\"2025-10-01T02:03:16.161Z\"),\n ends_at=parse_datetime(\"2026-03-04T09:29:46.413Z\"),\n ended_at=parse_datetime(\"2026-11-15T17:24:36.671Z\"),\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n checkout_id=\"\",\n customer_cancellation_reason=polar_sdk.CustomerCancellationReason.UNUSED,\n customer_cancellation_comment=\"\",\n ),\n items=[\n polar_sdk.OrderItemSchema(\n created_at=parse_datetime(\"2025-03-12T02:07:55.904Z\"),\n modified_at=parse_datetime(\"2024-08-25T12:56:24.423Z\"),\n id=\"\",\n label=\"Pro Plan\",\n amount=10000,\n tax_amount=720,\n proration=False,\n product_price_id=\"\",\n ),\n ],\n description=\"Pro Plan\",\n ),\n ))\n\n # Handle response\n print(res)" - target: $["paths"]["organization.updated"]["post"] update: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointorganization_updated_post(request=polar_sdk.WebhookOrganizationUpdatedPayload(\n timestamp=parse_datetime(\"2026-08-19T15:02:44.139Z\"),\n data=polar_sdk.Organization(\n created_at=parse_datetime(\"2026-05-07T21:24:48.059Z\"),\n modified_at=parse_datetime(\"2024-04-15T23:18:12.986Z\"),\n id=\"\",\n name=\"\",\n slug=\"\",\n avatar_url=\"https://pessimistic-going.name/\",\n proration_behavior=polar_sdk.SubscriptionProrationBehavior.NEXT_PERIOD,\n allow_customer_updates=True,\n email=\"Marianne.Haag@yahoo.com\",\n website=None,\n socials=[],\n status=polar_sdk.OrganizationStatus.INITIAL_REVIEW,\n details_submitted_at=parse_datetime(\"2025-06-29T16:05:16.127Z\"),\n default_presentment_currency=\"\",\n feature_settings=polar_sdk.OrganizationFeatureSettings(),\n subscription_settings=polar_sdk.OrganizationSubscriptionSettings(\n allow_multiple_subscriptions=False,\n allow_customer_updates=True,\n proration_behavior=polar_sdk.SubscriptionProrationBehavior.PRORATE,\n benefit_revocation_grace_period=778168,\n prevent_trial_abuse=False,\n ),\n notification_settings=polar_sdk.OrganizationNotificationSettings(\n new_order=True,\n new_subscription=False,\n ),\n customer_email_settings=polar_sdk.OrganizationCustomerEmailSettings(\n order_confirmation=True,\n subscription_cancellation=True,\n subscription_confirmation=True,\n subscription_cycled=False,\n subscription_cycled_after_trial=True,\n subscription_past_due=False,\n subscription_revoked=False,\n subscription_uncanceled=True,\n subscription_updated=True,\n ),\n customer_portal_settings=polar_sdk.OrganizationCustomerPortalSettings(\n usage=polar_sdk.CustomerPortalUsageSettings(\n show=True,\n ),\n subscription=polar_sdk.CustomerPortalSubscriptionSettings(\n update_seats=False,\n update_plan=True,\n ),\n ),\n ),\n ))\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointorganization_updated_post(request=polar_sdk.WebhookOrganizationUpdatedPayload(\n timestamp=parse_datetime(\"2026-08-19T15:02:44.139Z\"),\n data=polar_sdk.Organization(\n created_at=parse_datetime(\"2026-05-07T21:24:48.059Z\"),\n modified_at=parse_datetime(\"2024-04-15T23:18:12.986Z\"),\n id=\"\",\n name=\"\",\n slug=\"\",\n avatar_url=\"https://pessimistic-going.name/\",\n proration_behavior=polar_sdk.SubscriptionProrationBehavior.NEXT_PERIOD,\n allow_customer_updates=True,\n email=\"Marianne.Haag@yahoo.com\",\n website=None,\n socials=[],\n status=polar_sdk.OrganizationStatus.INITIAL_REVIEW,\n details_submitted_at=parse_datetime(\"2025-06-29T16:05:16.127Z\"),\n default_presentment_currency=\"\",\n default_tax_behavior=polar_sdk.TaxBehaviorOption.EXCLUSIVE,\n feature_settings=polar_sdk.OrganizationFeatureSettings(),\n subscription_settings=polar_sdk.OrganizationSubscriptionSettings(\n allow_multiple_subscriptions=True,\n allow_customer_updates=True,\n proration_behavior=polar_sdk.SubscriptionProrationBehavior.NEXT_PERIOD,\n benefit_revocation_grace_period=570350,\n prevent_trial_abuse=True,\n ),\n notification_settings=polar_sdk.OrganizationNotificationSettings(\n new_order=False,\n new_subscription=True,\n ),\n customer_email_settings=polar_sdk.OrganizationCustomerEmailSettings(\n order_confirmation=True,\n subscription_cancellation=True,\n subscription_confirmation=False,\n subscription_cycled=True,\n subscription_cycled_after_trial=False,\n subscription_past_due=False,\n subscription_renewal_reminder=True,\n subscription_revoked=True,\n subscription_trial_conversion_reminder=True,\n subscription_uncanceled=False,\n subscription_updated=True,\n ),\n customer_portal_settings=polar_sdk.OrganizationCustomerPortalSettings(\n usage=polar_sdk.CustomerPortalUsageSettings(\n show=False,\n ),\n subscription=polar_sdk.CustomerPortalSubscriptionSettings(\n update_seats=False,\n update_plan=False,\n ),\n ),\n ),\n ))\n\n # Handle response\n print(res)" - target: $["paths"]["product.created"]["post"] update: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointproduct_created_post(request={\n \"type\": \"product.created\",\n \"timestamp\": parse_datetime(\"2024-10-12T02:47:55.082Z\"),\n \"data\": {\n \"id\": \"\",\n \"created_at\": parse_datetime(\"2024-01-15T03:15:59.062Z\"),\n \"modified_at\": parse_datetime(\"2024-07-03T11:33:29.001Z\"),\n \"trial_interval\": polar_sdk.TrialInterval.DAY,\n \"trial_interval_count\": 130829,\n \"name\": \"\",\n \"description\": \"generously as at filthy busy athwart\",\n \"visibility\": polar_sdk.ProductVisibility.DRAFT,\n \"recurring_interval\": polar_sdk.SubscriptionRecurringInterval.WEEK,\n \"recurring_interval_count\": 580203,\n \"is_recurring\": True,\n \"is_archived\": True,\n \"organization_id\": \"\",\n \"metadata\": {\n\n },\n \"prices\": [\n {\n \"created_at\": parse_datetime(\"2024-08-02T23:19:06.054Z\"),\n \"modified_at\": parse_datetime(\"2025-01-29T21:27:39.006Z\"),\n \"id\": \"\",\n \"source\": polar_sdk.ProductPriceSource.CATALOG,\n \"amount_type\": \"custom\",\n \"price_currency\": \"\",\n \"is_archived\": True,\n \"product_id\": \"\",\n \"type\": \"recurring\",\n \"recurring_interval\": polar_sdk.SubscriptionRecurringInterval.MONTH,\n \"minimum_amount\": 217398,\n \"maximum_amount\": 927218,\n \"preset_amount\": 804154,\n \"legacy\": True,\n },\n ],\n \"benefits\": [],\n \"medias\": [],\n \"attached_custom_fields\": [],\n },\n })\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointproduct_created_post(request={\n \"type\": \"product.created\",\n \"timestamp\": parse_datetime(\"2024-10-12T02:47:55.082Z\"),\n \"data\": {\n \"id\": \"\",\n \"created_at\": parse_datetime(\"2024-01-15T03:15:59.062Z\"),\n \"modified_at\": parse_datetime(\"2024-07-03T11:33:29.001Z\"),\n \"trial_interval\": polar_sdk.TrialInterval.DAY,\n \"trial_interval_count\": 130829,\n \"name\": \"\",\n \"description\": \"generously as at filthy busy athwart\",\n \"visibility\": polar_sdk.ProductVisibility.DRAFT,\n \"recurring_interval\": polar_sdk.SubscriptionRecurringInterval.WEEK,\n \"recurring_interval_count\": 580203,\n \"is_recurring\": True,\n \"is_archived\": True,\n \"organization_id\": \"\",\n \"metadata\": {\n\n },\n \"prices\": [\n {\n \"created_at\": parse_datetime(\"2024-08-02T23:19:06.054Z\"),\n \"modified_at\": parse_datetime(\"2025-01-29T21:27:39.006Z\"),\n \"id\": \"\",\n \"source\": polar_sdk.ProductPriceSource.CATALOG,\n \"amount_type\": \"custom\",\n \"price_currency\": \"\",\n \"tax_behavior\": polar_sdk.TaxBehaviorOption.INCLUSIVE,\n \"is_archived\": True,\n \"product_id\": \"\",\n \"type\": \"recurring\",\n \"recurring_interval\": polar_sdk.SubscriptionRecurringInterval.YEAR,\n \"minimum_amount\": 927218,\n \"maximum_amount\": 804154,\n \"preset_amount\": 279270,\n \"legacy\": True,\n },\n ],\n \"benefits\": [],\n \"medias\": [],\n \"attached_custom_fields\": [],\n },\n })\n\n # Handle response\n print(res)" - target: $["paths"]["product.updated"]["post"] update: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointproduct_updated_post(request={\n \"type\": \"product.updated\",\n \"timestamp\": parse_datetime(\"2025-08-25T02:00:54.049Z\"),\n \"data\": {\n \"id\": \"\",\n \"created_at\": parse_datetime(\"2026-02-11T18:19:05.372Z\"),\n \"modified_at\": parse_datetime(\"2026-07-31T19:14:23.351Z\"),\n \"trial_interval\": polar_sdk.TrialInterval.YEAR,\n \"trial_interval_count\": 907633,\n \"name\": \"\",\n \"description\": \"square extract modulo bossy outlandish pecan\",\n \"visibility\": polar_sdk.ProductVisibility.DRAFT,\n \"recurring_interval\": polar_sdk.SubscriptionRecurringInterval.MONTH,\n \"recurring_interval_count\": 844227,\n \"is_recurring\": True,\n \"is_archived\": True,\n \"organization_id\": \"\",\n \"metadata\": {\n \"key\": 731170,\n },\n \"prices\": [\n {\n \"created_at\": parse_datetime(\"2024-02-07T02:48:19.584Z\"),\n \"modified_at\": parse_datetime(\"2024-06-19T05:51:14.673Z\"),\n \"id\": \"\",\n \"source\": polar_sdk.ProductPriceSource.CATALOG,\n \"amount_type\": \"free\",\n \"price_currency\": \"\",\n \"is_archived\": False,\n \"product_id\": \"\",\n \"type\": \"recurring\",\n \"recurring_interval\": polar_sdk.SubscriptionRecurringInterval.MONTH,\n \"legacy\": True,\n },\n ],\n \"benefits\": [\n {\n \"id\": \"\",\n \"created_at\": parse_datetime(\"2026-03-23T19:36:20.342Z\"),\n \"modified_at\": parse_datetime(\"2025-06-26T23:01:23.486Z\"),\n \"type\": \"license_keys\",\n \"description\": \"desecrate carelessly inasmuch magnetize brr fatally hm hepatitis neglected\",\n \"selectable\": True,\n \"deletable\": True,\n \"organization_id\": \"\",\n \"metadata\": {\n \"key\": \"\",\n },\n \"properties\": {\n \"prefix\": \"\",\n \"expires\": None,\n \"activations\": {\n \"limit\": 296191,\n \"enable_customer_admin\": False,\n },\n \"limit_usage\": 515370,\n },\n },\n ],\n \"medias\": [\n {\n \"id\": \"\",\n \"organization_id\": \"\",\n \"name\": \"\",\n \"path\": \"/sbin\",\n \"mime_type\": \"\",\n \"size\": 484942,\n \"storage_version\": \"\",\n \"checksum_etag\": None,\n \"checksum_sha256_base64\": \"\",\n \"checksum_sha256_hex\": \"\",\n \"last_modified_at\": parse_datetime(\"2026-12-10T15:58:54.928Z\"),\n \"version\": \"\",\n \"service\": \"product_media\",\n \"is_uploaded\": False,\n \"created_at\": parse_datetime(\"2026-06-15T04:30:20.706Z\"),\n \"size_readable\": \"\",\n \"public_url\": \"https://fat-effector.biz/\",\n },\n ],\n \"attached_custom_fields\": [],\n },\n })\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointproduct_updated_post(request={\n \"type\": \"product.updated\",\n \"timestamp\": parse_datetime(\"2025-08-25T02:00:54.049Z\"),\n \"data\": {\n \"id\": \"\",\n \"created_at\": parse_datetime(\"2026-02-11T18:19:05.372Z\"),\n \"modified_at\": parse_datetime(\"2026-07-31T19:14:23.351Z\"),\n \"trial_interval\": polar_sdk.TrialInterval.YEAR,\n \"trial_interval_count\": 907633,\n \"name\": \"\",\n \"description\": \"square extract modulo bossy outlandish pecan\",\n \"visibility\": polar_sdk.ProductVisibility.DRAFT,\n \"recurring_interval\": polar_sdk.SubscriptionRecurringInterval.MONTH,\n \"recurring_interval_count\": 844227,\n \"is_recurring\": True,\n \"is_archived\": True,\n \"organization_id\": \"\",\n \"metadata\": {\n \"key\": 731170,\n },\n \"prices\": [\n {\n \"created_at\": parse_datetime(\"2024-02-07T02:48:19.584Z\"),\n \"modified_at\": parse_datetime(\"2024-06-19T05:51:14.673Z\"),\n \"id\": \"\",\n \"source\": polar_sdk.ProductPriceSource.CATALOG,\n \"amount_type\": \"free\",\n \"price_currency\": \"\",\n \"tax_behavior\": polar_sdk.TaxBehaviorOption.EXCLUSIVE,\n \"is_archived\": False,\n \"product_id\": \"\",\n \"type\": \"recurring\",\n \"recurring_interval\": polar_sdk.SubscriptionRecurringInterval.MONTH,\n \"legacy\": True,\n },\n ],\n \"benefits\": [\n {\n \"id\": \"\",\n \"created_at\": parse_datetime(\"2025-06-26T23:01:23.486Z\"),\n \"modified_at\": parse_datetime(\"2024-10-21T14:48:34.794Z\"),\n \"type\": \"discord\",\n \"description\": \"phew if archaeology vibrant than uh-huh inasmuch hmph but rosemary\",\n \"selectable\": False,\n \"deletable\": False,\n \"organization_id\": \"\",\n \"metadata\": {\n \"key\": 4849.42,\n },\n \"properties\": {\n \"guild_id\": \"\",\n \"role_id\": \"\",\n \"kick_member\": True,\n \"guild_token\": \"\",\n },\n },\n ],\n \"medias\": [],\n \"attached_custom_fields\": [],\n },\n })\n\n # Handle response\n print(res)" - target: $["paths"]["refund.created"]["post"] update: "x-codeSamples": @@ -1190,40 +1190,40 @@ actions: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointsubscription_active_post(request=polar_sdk.WebhookSubscriptionActivePayload(\n timestamp=parse_datetime(\"2024-08-12T01:28:21.362Z\"),\n data=polar_sdk.Subscription(\n created_at=parse_datetime(\"2024-10-11T10:17:29.274Z\"),\n modified_at=parse_datetime(\"2024-12-17T04:45:55.702Z\"),\n id=\"\",\n amount=10000,\n currency=\"usd\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.YEAR,\n recurring_interval_count=291908,\n status=polar_sdk.SubscriptionStatus.PAST_DUE,\n current_period_start=parse_datetime(\"2024-06-08T14:14:48.363Z\"),\n current_period_end=parse_datetime(\"2024-04-08T09:06:19.384Z\"),\n trial_start=None,\n trial_end=None,\n cancel_at_period_end=False,\n canceled_at=parse_datetime(\"2025-09-14T15:19:58.463Z\"),\n started_at=parse_datetime(\"2025-07-30T05:01:30.550Z\"),\n ends_at=parse_datetime(\"2025-02-01T06:13:13.441Z\"),\n ended_at=parse_datetime(\"2024-10-09T03:15:20.759Z\"),\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n checkout_id=\"\",\n customer_cancellation_reason=polar_sdk.CustomerCancellationReason.UNUSED,\n customer_cancellation_comment=\"\",\n metadata={\n \"key\": 667866,\n },\n customer=polar_sdk.SubscriptionCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2026-02-14T12:59:50.680Z\"),\n modified_at=parse_datetime(\"2026-03-11T11:17:02.540Z\"),\n metadata={\n\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2024-04-07T22:28:00.101Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=polar_sdk.Product(\n id=\"\",\n created_at=parse_datetime(\"2026-11-05T10:18:40.300Z\"),\n modified_at=parse_datetime(\"2025-04-23T18:24:43.408Z\"),\n trial_interval=polar_sdk.TrialInterval.YEAR,\n trial_interval_count=714669,\n name=\"\",\n description=\"amongst incidentally irritably cauliflower antique\",\n visibility=polar_sdk.ProductVisibility.PRIVATE,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n recurring_interval_count=None,\n is_recurring=True,\n is_archived=True,\n organization_id=\"\",\n metadata={\n \"key\": False,\n },\n prices=[\n polar_sdk.LegacyRecurringProductPriceCustom(\n created_at=parse_datetime(\"2026-03-24T10:57:36.466Z\"),\n modified_at=parse_datetime(\"2025-10-17T11:42:46.643Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n is_archived=True,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,\n minimum_amount=154892,\n maximum_amount=778615,\n preset_amount=829362,\n ),\n ],\n benefits=[\n polar_sdk.BenefitFeatureFlag(\n id=\"\",\n created_at=parse_datetime(\"2025-04-05T11:10:16.533Z\"),\n modified_at=parse_datetime(\"2024-02-12T06:44:11.052Z\"),\n description=\"against effector as upbeat yuck\",\n selectable=True,\n deletable=False,\n organization_id=\"\",\n metadata={\n \"key\": \"\",\n },\n properties=polar_sdk.BenefitFeatureFlagProperties(),\n ),\n ],\n medias=[\n polar_sdk.ProductMediaFileRead(\n id=\"\",\n organization_id=\"\",\n name=\"\",\n path=\"/media\",\n mime_type=\"\",\n size=18256,\n storage_version=\"\",\n checksum_etag=\"\",\n checksum_sha256_base64=\"\",\n checksum_sha256_hex=\"\",\n last_modified_at=parse_datetime(\"2024-04-08T15:13:09.162Z\"),\n version=\"\",\n is_uploaded=True,\n created_at=parse_datetime(\"2025-05-01T10:38:41.675Z\"),\n size_readable=\"\",\n public_url=\"https://favorable-lava.com\",\n ),\n ],\n attached_custom_fields=[],\n ),\n discount=polar_sdk.DiscountFixedRepeatDurationBase(\n duration=polar_sdk.DiscountDuration.FOREVER,\n duration_in_months=204827,\n type=polar_sdk.DiscountType.FIXED,\n amount=1000,\n currency=\"usd\",\n amounts={\n \"eur\": 900,\n \"usd\": 1000,\n },\n created_at=parse_datetime(\"2024-06-22T00:23:01.418Z\"),\n modified_at=parse_datetime(\"2024-08-21T07:22:13.326Z\"),\n id=\"\",\n metadata={\n \"key\": 268701,\n },\n name=\"\",\n code=\"\",\n starts_at=parse_datetime(\"2024-04-03T00:27:09.188Z\"),\n ends_at=parse_datetime(\"2025-08-25T11:20:18.677Z\"),\n max_redemptions=606883,\n redemptions_count=64507,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n prices=[\n polar_sdk.LegacyRecurringProductPriceCustom(\n created_at=parse_datetime(\"2025-03-30T14:50:52.711Z\"),\n modified_at=parse_datetime(\"2025-06-25T05:59:30.258Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.CATALOG,\n price_currency=\"\",\n is_archived=False,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.WEEK,\n minimum_amount=120061,\n maximum_amount=None,\n preset_amount=31018,\n ),\n ],\n meters=[],\n ),\n ))\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointsubscription_active_post(request=polar_sdk.WebhookSubscriptionActivePayload(\n timestamp=parse_datetime(\"2024-08-12T01:28:21.362Z\"),\n data=polar_sdk.Subscription(\n created_at=parse_datetime(\"2024-10-11T10:17:29.274Z\"),\n modified_at=parse_datetime(\"2024-12-17T04:45:55.702Z\"),\n id=\"\",\n amount=10000,\n currency=\"usd\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.YEAR,\n recurring_interval_count=291908,\n status=polar_sdk.SubscriptionStatus.PAST_DUE,\n current_period_start=parse_datetime(\"2024-06-08T14:14:48.363Z\"),\n current_period_end=parse_datetime(\"2024-04-08T09:06:19.384Z\"),\n trial_start=None,\n trial_end=None,\n cancel_at_period_end=False,\n canceled_at=parse_datetime(\"2025-09-14T15:19:58.463Z\"),\n started_at=parse_datetime(\"2025-07-30T05:01:30.550Z\"),\n ends_at=parse_datetime(\"2025-02-01T06:13:13.441Z\"),\n ended_at=parse_datetime(\"2024-10-09T03:15:20.759Z\"),\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n checkout_id=\"\",\n customer_cancellation_reason=polar_sdk.CustomerCancellationReason.UNUSED,\n customer_cancellation_comment=\"\",\n metadata={\n \"key\": 667866,\n },\n customer=polar_sdk.SubscriptionCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2026-02-14T12:59:50.680Z\"),\n modified_at=parse_datetime(\"2026-03-11T11:17:02.540Z\"),\n metadata={\n\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2024-04-07T22:28:00.101Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=polar_sdk.Product(\n id=\"\",\n created_at=parse_datetime(\"2026-11-05T10:18:40.300Z\"),\n modified_at=parse_datetime(\"2025-04-23T18:24:43.408Z\"),\n trial_interval=polar_sdk.TrialInterval.YEAR,\n trial_interval_count=714669,\n name=\"\",\n description=\"amongst incidentally irritably cauliflower antique\",\n visibility=polar_sdk.ProductVisibility.PRIVATE,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n recurring_interval_count=None,\n is_recurring=True,\n is_archived=True,\n organization_id=\"\",\n metadata={\n \"key\": False,\n },\n prices=[\n polar_sdk.LegacyRecurringProductPriceCustom(\n created_at=parse_datetime(\"2026-03-24T10:57:36.466Z\"),\n modified_at=parse_datetime(\"2025-10-17T11:42:46.643Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n tax_behavior=None,\n is_archived=False,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n minimum_amount=389288,\n maximum_amount=177303,\n preset_amount=561657,\n ),\n ],\n benefits=[],\n medias=[],\n attached_custom_fields=[\n polar_sdk.AttachedCustomField(\n custom_field_id=\"\",\n custom_field=polar_sdk.CustomFieldCheckbox(\n created_at=parse_datetime(\"2025-01-11T08:39:00.463Z\"),\n modified_at=parse_datetime(\"2026-03-02T23:03:24.214Z\"),\n id=\"\",\n metadata={\n\n },\n slug=\"\",\n name=\"\",\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n properties=polar_sdk.CustomFieldCheckboxProperties(),\n ),\n order=977457,\n required=False,\n ),\n ],\n ),\n discount=polar_sdk.DiscountFixedOnceForeverDurationBase(\n duration=polar_sdk.DiscountDuration.ONCE,\n type=polar_sdk.DiscountType.FIXED,\n amount=1000,\n currency=\"usd\",\n amounts={\n \"eur\": 900,\n \"usd\": 1000,\n },\n created_at=parse_datetime(\"2024-01-15T17:33:02.691Z\"),\n modified_at=parse_datetime(\"2025-04-26T17:17:19.419Z\"),\n id=\"\",\n metadata={\n \"key\": 123196,\n },\n name=\"\",\n code=\"\",\n starts_at=parse_datetime(\"2024-04-08T13:01:30.211Z\"),\n ends_at=parse_datetime(\"2026-04-05T20:05:32.381Z\"),\n max_redemptions=751909,\n redemptions_count=518919,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n prices=[],\n meters=[\n polar_sdk.SubscriptionMeter(\n created_at=parse_datetime(\"2025-02-20T06:23:41.365Z\"),\n modified_at=parse_datetime(\"2026-09-30T12:23:41.262Z\"),\n id=\"\",\n consumed_units=25,\n credited_units=100,\n amount=0,\n meter_id=\"d498a884-e2cd-4d3e-8002-f536468a8b22\",\n meter=polar_sdk.Meter(\n metadata={\n \"key\": True,\n },\n created_at=parse_datetime(\"2024-11-12T01:54:07.938Z\"),\n modified_at=parse_datetime(\"2024-12-17T08:10:47.455Z\"),\n id=\"\",\n name=\"\",\n filter_=polar_sdk.Filter(\n conjunction=polar_sdk.FilterConjunction.AND,\n clauses=[],\n ),\n aggregation=polar_sdk.PropertyAggregation(\n func=polar_sdk.Func.SUM,\n property=\"\",\n ),\n organization_id=\"\",\n ),\n ),\n ],\n pending_update=polar_sdk.PendingSubscriptionUpdate(\n created_at=parse_datetime(\"2024-02-01T22:18:30.882Z\"),\n modified_at=parse_datetime(\"2024-11-13T06:50:49.907Z\"),\n id=\"\",\n applies_at=parse_datetime(\"2024-01-21T00:13:21.130Z\"),\n product_id=\"\",\n seats=776442,\n ),\n ),\n ))\n\n # Handle response\n print(res)" - target: $["paths"]["subscription.canceled"]["post"] update: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointsubscription_canceled_post(request=polar_sdk.WebhookSubscriptionCanceledPayload(\n timestamp=parse_datetime(\"2026-02-09T04:39:02.332Z\"),\n data=polar_sdk.Subscription(\n created_at=parse_datetime(\"2026-04-09T17:46:08.645Z\"),\n modified_at=None,\n id=\"\",\n amount=10000,\n currency=\"usd\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n recurring_interval_count=867179,\n status=polar_sdk.SubscriptionStatus.INCOMPLETE_EXPIRED,\n current_period_start=parse_datetime(\"2025-08-12T22:41:41.907Z\"),\n current_period_end=parse_datetime(\"2024-06-16T04:15:56.819Z\"),\n trial_start=parse_datetime(\"2024-06-01T15:48:16.857Z\"),\n trial_end=parse_datetime(\"2026-07-17T03:56:59.092Z\"),\n cancel_at_period_end=True,\n canceled_at=parse_datetime(\"2026-02-23T12:23:49.579Z\"),\n started_at=parse_datetime(\"2024-11-15T08:24:59.166Z\"),\n ends_at=parse_datetime(\"2024-07-20T16:25:14.433Z\"),\n ended_at=None,\n customer_id=\"\",\n product_id=\"\",\n discount_id=None,\n checkout_id=None,\n customer_cancellation_reason=polar_sdk.CustomerCancellationReason.LOW_QUALITY,\n customer_cancellation_comment=\"\",\n metadata={\n\n },\n customer=polar_sdk.SubscriptionCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2024-09-19T10:20:50.540Z\"),\n modified_at=parse_datetime(\"2026-12-01T17:01:38.429Z\"),\n metadata={\n\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2024-07-12T08:26:56.650Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=polar_sdk.Product(\n id=\"\",\n created_at=parse_datetime(\"2026-06-11T17:21:10.206Z\"),\n modified_at=parse_datetime(\"2026-03-18T13:26:34.470Z\"),\n trial_interval=polar_sdk.TrialInterval.DAY,\n trial_interval_count=72014,\n name=\"\",\n description=\"for for average aw weakly inside beneath ack stylish or\",\n visibility=polar_sdk.ProductVisibility.PRIVATE,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n recurring_interval_count=839446,\n is_recurring=True,\n is_archived=True,\n organization_id=\"\",\n metadata={\n\n },\n prices=[\n polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2024-05-15T03:39:22.008Z\"),\n modified_at=parse_datetime(\"2025-12-06T03:04:40.212Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n is_archived=False,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n price_amount=528286,\n ),\n ],\n benefits=[],\n medias=[\n polar_sdk.ProductMediaFileRead(\n id=\"\",\n organization_id=\"\",\n name=\"\",\n path=\"/opt/bin\",\n mime_type=\"\",\n size=145279,\n storage_version=None,\n checksum_etag=None,\n checksum_sha256_base64=\"\",\n checksum_sha256_hex=\"\",\n last_modified_at=parse_datetime(\"2024-06-20T14:17:32.355Z\"),\n version=\"\",\n is_uploaded=True,\n created_at=parse_datetime(\"2026-01-10T23:59:33.152Z\"),\n size_readable=\"\",\n public_url=\"https://wordy-pacemaker.com\",\n ),\n ],\n attached_custom_fields=[\n polar_sdk.AttachedCustomField(\n custom_field_id=\"\",\n custom_field=polar_sdk.CustomFieldText(\n created_at=parse_datetime(\"2024-03-06T15:42:46.324Z\"),\n modified_at=parse_datetime(\"2025-09-08T21:12:01.583Z\"),\n id=\"\",\n metadata={\n\n },\n slug=\"\",\n name=\"\",\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n properties=polar_sdk.CustomFieldTextProperties(),\n ),\n order=147849,\n required=False,\n ),\n ],\n ),\n discount=polar_sdk.DiscountFixedRepeatDurationBase(\n duration=polar_sdk.DiscountDuration.ONCE,\n duration_in_months=162086,\n type=polar_sdk.DiscountType.PERCENTAGE,\n amount=1000,\n currency=\"usd\",\n amounts={\n \"eur\": 900,\n \"usd\": 1000,\n },\n created_at=parse_datetime(\"2024-11-03T02:42:56.601Z\"),\n modified_at=parse_datetime(\"2025-09-21T23:00:18.902Z\"),\n id=\"\",\n metadata={\n\n },\n name=\"\",\n code=\"\",\n starts_at=None,\n ends_at=parse_datetime(\"2024-04-22T23:15:25.201Z\"),\n max_redemptions=416604,\n redemptions_count=978284,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n prices=[],\n meters=[],\n ),\n ))\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointsubscription_canceled_post(request=polar_sdk.WebhookSubscriptionCanceledPayload(\n timestamp=parse_datetime(\"2026-02-09T04:39:02.332Z\"),\n data=polar_sdk.Subscription(\n created_at=parse_datetime(\"2026-04-09T17:46:08.645Z\"),\n modified_at=None,\n id=\"\",\n amount=10000,\n currency=\"usd\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n recurring_interval_count=867179,\n status=polar_sdk.SubscriptionStatus.INCOMPLETE_EXPIRED,\n current_period_start=parse_datetime(\"2025-08-12T22:41:41.907Z\"),\n current_period_end=parse_datetime(\"2024-06-16T04:15:56.819Z\"),\n trial_start=parse_datetime(\"2024-06-01T15:48:16.857Z\"),\n trial_end=parse_datetime(\"2026-07-17T03:56:59.092Z\"),\n cancel_at_period_end=True,\n canceled_at=parse_datetime(\"2026-02-23T12:23:49.579Z\"),\n started_at=parse_datetime(\"2024-11-15T08:24:59.166Z\"),\n ends_at=parse_datetime(\"2024-07-20T16:25:14.433Z\"),\n ended_at=None,\n customer_id=\"\",\n product_id=\"\",\n discount_id=None,\n checkout_id=None,\n customer_cancellation_reason=polar_sdk.CustomerCancellationReason.LOW_QUALITY,\n customer_cancellation_comment=\"\",\n metadata={\n\n },\n customer=polar_sdk.SubscriptionCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2024-09-19T10:20:50.540Z\"),\n modified_at=parse_datetime(\"2026-12-01T17:01:38.429Z\"),\n metadata={\n\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2024-07-12T08:26:56.650Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=polar_sdk.Product(\n id=\"\",\n created_at=parse_datetime(\"2026-06-11T17:21:10.206Z\"),\n modified_at=parse_datetime(\"2026-03-18T13:26:34.470Z\"),\n trial_interval=polar_sdk.TrialInterval.DAY,\n trial_interval_count=72014,\n name=\"\",\n description=\"for for average aw weakly inside beneath ack stylish or\",\n visibility=polar_sdk.ProductVisibility.PRIVATE,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n recurring_interval_count=839446,\n is_recurring=True,\n is_archived=True,\n organization_id=\"\",\n metadata={\n\n },\n prices=[\n polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2024-05-15T03:39:22.008Z\"),\n modified_at=parse_datetime(\"2025-12-06T03:04:40.212Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n tax_behavior=polar_sdk.TaxBehaviorOption.LOCATION,\n is_archived=False,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.WEEK,\n price_amount=840150,\n ),\n ],\n benefits=[],\n medias=[],\n attached_custom_fields=[],\n ),\n discount=None,\n prices=[],\n meters=[\n polar_sdk.SubscriptionMeter(\n created_at=parse_datetime(\"2025-03-25T15:50:28.196Z\"),\n modified_at=parse_datetime(\"2024-04-26T03:07:49.939Z\"),\n id=\"\",\n consumed_units=25,\n credited_units=100,\n amount=0,\n meter_id=\"d498a884-e2cd-4d3e-8002-f536468a8b22\",\n meter=polar_sdk.Meter(\n metadata={\n\n },\n created_at=parse_datetime(\"2026-01-10T23:59:33.152Z\"),\n modified_at=parse_datetime(\"2026-12-09T20:48:19.909Z\"),\n id=\"\",\n name=\"\",\n filter_=polar_sdk.Filter(\n conjunction=polar_sdk.FilterConjunction.OR,\n clauses=[],\n ),\n aggregation=polar_sdk.UniqueAggregation(\n property=\"\",\n ),\n organization_id=\"\",\n ),\n ),\n ],\n pending_update=polar_sdk.PendingSubscriptionUpdate(\n created_at=parse_datetime(\"2024-03-06T15:42:46.324Z\"),\n modified_at=parse_datetime(\"2025-09-08T21:12:01.583Z\"),\n id=\"\",\n applies_at=parse_datetime(\"2025-01-23T04:52:40.375Z\"),\n product_id=\"\",\n seats=151549,\n ),\n ),\n ))\n\n # Handle response\n print(res)" - target: $["paths"]["subscription.created"]["post"] update: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointsubscription_created_post(request=polar_sdk.WebhookSubscriptionCreatedPayload(\n timestamp=parse_datetime(\"2025-05-03T11:46:21.459Z\"),\n data=polar_sdk.Subscription(\n created_at=parse_datetime(\"2024-12-02T10:52:23.880Z\"),\n modified_at=parse_datetime(\"2025-05-29T05:21:44.072Z\"),\n id=\"\",\n amount=10000,\n currency=\"usd\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n recurring_interval_count=990795,\n status=polar_sdk.SubscriptionStatus.INCOMPLETE,\n current_period_start=parse_datetime(\"2025-01-06T06:33:36.381Z\"),\n current_period_end=parse_datetime(\"2025-02-02T21:22:53.116Z\"),\n trial_start=parse_datetime(\"2024-10-19T18:48:25.568Z\"),\n trial_end=parse_datetime(\"2024-09-09T18:39:16.136Z\"),\n cancel_at_period_end=True,\n canceled_at=parse_datetime(\"2025-09-02T19:02:23.015Z\"),\n started_at=parse_datetime(\"2024-08-18T21:45:43.735Z\"),\n ends_at=parse_datetime(\"2024-03-14T19:14:53.866Z\"),\n ended_at=parse_datetime(\"2025-04-01T08:29:51.925Z\"),\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n checkout_id=\"\",\n customer_cancellation_reason=polar_sdk.CustomerCancellationReason.UNUSED,\n customer_cancellation_comment=\"\",\n metadata={\n\n },\n customer=polar_sdk.SubscriptionCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2025-09-10T08:59:46.091Z\"),\n modified_at=parse_datetime(\"2025-07-06T00:27:46.272Z\"),\n metadata={\n \"key\": 9576.45,\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2026-06-26T21:09:46.234Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=polar_sdk.Product(\n id=\"\",\n created_at=parse_datetime(\"2024-05-14T22:05:41.858Z\"),\n modified_at=parse_datetime(\"2025-01-30T16:35:38.441Z\"),\n trial_interval=polar_sdk.TrialInterval.YEAR,\n trial_interval_count=271531,\n name=\"\",\n description=\"platypus scrape adventurously which cautiously secret completion\",\n visibility=polar_sdk.ProductVisibility.PRIVATE,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.YEAR,\n recurring_interval_count=591901,\n is_recurring=True,\n is_archived=True,\n organization_id=\"\",\n metadata={\n\n },\n prices=[],\n benefits=[],\n medias=[],\n attached_custom_fields=[\n polar_sdk.AttachedCustomField(\n custom_field_id=\"\",\n custom_field=polar_sdk.CustomFieldText(\n created_at=parse_datetime(\"2026-08-19T12:34:00.701Z\"),\n modified_at=parse_datetime(\"2026-04-03T20:11:30.100Z\"),\n id=\"\",\n metadata={\n \"key\": 6862.16,\n },\n slug=\"\",\n name=\"\",\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n properties=polar_sdk.CustomFieldTextProperties(),\n ),\n order=149871,\n required=True,\n ),\n ],\n ),\n discount=polar_sdk.DiscountFixedOnceForeverDurationBase(\n duration=polar_sdk.DiscountDuration.FOREVER,\n type=polar_sdk.DiscountType.FIXED,\n amount=1000,\n currency=\"usd\",\n amounts={\n \"eur\": 900,\n \"usd\": 1000,\n },\n created_at=parse_datetime(\"2026-12-17T08:21:24.389Z\"),\n modified_at=parse_datetime(\"2026-05-28T01:01:51.966Z\"),\n id=\"\",\n metadata={\n\n },\n name=\"\",\n code=\"\",\n starts_at=parse_datetime(\"2024-06-16T21:54:34.689Z\"),\n ends_at=parse_datetime(\"2025-01-28T17:06:11.180Z\"),\n max_redemptions=691175,\n redemptions_count=794334,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n prices=[\n polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2026-07-04T09:22:41.058Z\"),\n modified_at=parse_datetime(\"2025-10-27T12:22:08.463Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.CATALOG,\n price_currency=\"\",\n is_archived=False,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.WEEK,\n price_amount=707822,\n ),\n ],\n meters=[\n polar_sdk.SubscriptionMeter(\n created_at=parse_datetime(\"2024-03-06T23:51:22.319Z\"),\n modified_at=parse_datetime(\"2026-12-01T13:59:05.249Z\"),\n id=\"\",\n consumed_units=25,\n credited_units=100,\n amount=0,\n meter_id=\"d498a884-e2cd-4d3e-8002-f536468a8b22\",\n meter=polar_sdk.Meter(\n metadata={\n\n },\n created_at=parse_datetime(\"2024-05-30T15:26:51.884Z\"),\n modified_at=parse_datetime(\"2024-12-20T05:13:03.582Z\"),\n id=\"\",\n name=\"\",\n filter_=polar_sdk.Filter(\n conjunction=polar_sdk.FilterConjunction.OR,\n clauses=[\n polar_sdk.Filter(\n conjunction=polar_sdk.FilterConjunction.OR,\n clauses=[],\n ),\n ],\n ),\n aggregation=polar_sdk.PropertyAggregation(\n func=polar_sdk.Func.MIN,\n property=\"\",\n ),\n organization_id=\"\",\n ),\n ),\n ],\n ),\n ))\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointsubscription_created_post(request=polar_sdk.WebhookSubscriptionCreatedPayload(\n timestamp=parse_datetime(\"2025-05-03T11:46:21.459Z\"),\n data=polar_sdk.Subscription(\n created_at=parse_datetime(\"2024-12-02T10:52:23.880Z\"),\n modified_at=parse_datetime(\"2025-05-29T05:21:44.072Z\"),\n id=\"\",\n amount=10000,\n currency=\"usd\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n recurring_interval_count=990795,\n status=polar_sdk.SubscriptionStatus.INCOMPLETE,\n current_period_start=parse_datetime(\"2025-01-06T06:33:36.381Z\"),\n current_period_end=parse_datetime(\"2025-02-02T21:22:53.116Z\"),\n trial_start=parse_datetime(\"2024-10-19T18:48:25.568Z\"),\n trial_end=parse_datetime(\"2024-09-09T18:39:16.136Z\"),\n cancel_at_period_end=True,\n canceled_at=parse_datetime(\"2025-09-02T19:02:23.015Z\"),\n started_at=parse_datetime(\"2024-08-18T21:45:43.735Z\"),\n ends_at=parse_datetime(\"2024-03-14T19:14:53.866Z\"),\n ended_at=parse_datetime(\"2025-04-01T08:29:51.925Z\"),\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n checkout_id=\"\",\n customer_cancellation_reason=polar_sdk.CustomerCancellationReason.UNUSED,\n customer_cancellation_comment=\"\",\n metadata={\n\n },\n customer=polar_sdk.SubscriptionCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2025-09-10T08:59:46.091Z\"),\n modified_at=parse_datetime(\"2025-07-06T00:27:46.272Z\"),\n metadata={\n \"key\": 9576.45,\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2026-06-26T21:09:46.234Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=polar_sdk.Product(\n id=\"\",\n created_at=parse_datetime(\"2024-05-14T22:05:41.858Z\"),\n modified_at=parse_datetime(\"2025-01-30T16:35:38.441Z\"),\n trial_interval=polar_sdk.TrialInterval.YEAR,\n trial_interval_count=271531,\n name=\"\",\n description=\"platypus scrape adventurously which cautiously secret completion\",\n visibility=polar_sdk.ProductVisibility.PRIVATE,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.YEAR,\n recurring_interval_count=591901,\n is_recurring=True,\n is_archived=True,\n organization_id=\"\",\n metadata={\n\n },\n prices=[],\n benefits=[],\n medias=[],\n attached_custom_fields=[\n polar_sdk.AttachedCustomField(\n custom_field_id=\"\",\n custom_field=polar_sdk.CustomFieldText(\n created_at=parse_datetime(\"2026-08-19T12:34:00.701Z\"),\n modified_at=parse_datetime(\"2026-04-03T20:11:30.100Z\"),\n id=\"\",\n metadata={\n \"key\": 6862.16,\n },\n slug=\"\",\n name=\"\",\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n properties=polar_sdk.CustomFieldTextProperties(),\n ),\n order=149871,\n required=True,\n ),\n ],\n ),\n discount=polar_sdk.DiscountFixedOnceForeverDurationBase(\n duration=polar_sdk.DiscountDuration.FOREVER,\n type=polar_sdk.DiscountType.FIXED,\n amount=1000,\n currency=\"usd\",\n amounts={\n \"eur\": 900,\n \"usd\": 1000,\n },\n created_at=parse_datetime(\"2026-12-17T08:21:24.389Z\"),\n modified_at=parse_datetime(\"2026-05-28T01:01:51.966Z\"),\n id=\"\",\n metadata={\n\n },\n name=\"\",\n code=\"\",\n starts_at=parse_datetime(\"2024-06-16T21:54:34.689Z\"),\n ends_at=parse_datetime(\"2025-01-28T17:06:11.180Z\"),\n max_redemptions=691175,\n redemptions_count=794334,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n prices=[\n polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2026-07-04T09:22:41.058Z\"),\n modified_at=parse_datetime(\"2025-10-27T12:22:08.463Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.CATALOG,\n price_currency=\"\",\n tax_behavior=polar_sdk.TaxBehaviorOption.EXCLUSIVE,\n is_archived=False,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.WEEK,\n price_amount=60213,\n ),\n ],\n meters=[\n polar_sdk.SubscriptionMeter(\n created_at=parse_datetime(\"2026-12-01T13:59:05.249Z\"),\n modified_at=parse_datetime(\"2024-05-30T15:26:51.884Z\"),\n id=\"\",\n consumed_units=25,\n credited_units=100,\n amount=0,\n meter_id=\"d498a884-e2cd-4d3e-8002-f536468a8b22\",\n meter=polar_sdk.Meter(\n metadata={\n\n },\n created_at=parse_datetime(\"2024-12-20T05:13:03.582Z\"),\n modified_at=parse_datetime(\"2026-12-18T04:49:27.384Z\"),\n id=\"\",\n name=\"\",\n filter_=polar_sdk.Filter(\n conjunction=polar_sdk.FilterConjunction.OR,\n clauses=[\n polar_sdk.Filter(\n conjunction=polar_sdk.FilterConjunction.AND,\n clauses=[],\n ),\n ],\n ),\n aggregation=polar_sdk.PropertyAggregation(\n func=polar_sdk.Func.AVG,\n property=\"\",\n ),\n organization_id=\"\",\n ),\n ),\n ],\n pending_update=polar_sdk.PendingSubscriptionUpdate(\n created_at=parse_datetime(\"2026-11-29T21:22:35.202Z\"),\n modified_at=parse_datetime(\"2025-10-03T11:03:25.778Z\"),\n id=\"\",\n applies_at=parse_datetime(\"2026-01-02T18:50:53.887Z\"),\n product_id=None,\n seats=86855,\n ),\n ),\n ))\n\n # Handle response\n print(res)" - target: $["paths"]["subscription.past_due"]["post"] update: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointsubscription_past_due_post(request=polar_sdk.WebhookSubscriptionPastDuePayload(\n timestamp=parse_datetime(\"2025-08-08T08:08:34.879Z\"),\n data=polar_sdk.Subscription(\n created_at=parse_datetime(\"2025-08-04T16:17:07.577Z\"),\n modified_at=parse_datetime(\"2025-12-31T22:57:08.265Z\"),\n id=\"\",\n amount=10000,\n currency=\"usd\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.WEEK,\n recurring_interval_count=546644,\n status=polar_sdk.SubscriptionStatus.PAST_DUE,\n current_period_start=parse_datetime(\"2025-11-30T09:38:02.409Z\"),\n current_period_end=parse_datetime(\"2025-09-12T10:41:08.869Z\"),\n trial_start=parse_datetime(\"2025-04-18T01:48:54.159Z\"),\n trial_end=parse_datetime(\"2026-12-17T23:19:51.561Z\"),\n cancel_at_period_end=False,\n canceled_at=parse_datetime(\"2026-03-24T06:54:09.981Z\"),\n started_at=parse_datetime(\"2026-07-30T18:40:35.200Z\"),\n ends_at=parse_datetime(\"2026-05-14T09:53:26.015Z\"),\n ended_at=parse_datetime(\"2025-05-26T17:14:22.064Z\"),\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n checkout_id=\"\",\n customer_cancellation_reason=polar_sdk.CustomerCancellationReason.OTHER,\n customer_cancellation_comment=None,\n metadata={\n\n },\n customer=polar_sdk.SubscriptionCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2026-04-22T03:52:11.592Z\"),\n modified_at=parse_datetime(\"2024-04-06T18:32:38.832Z\"),\n metadata={\n\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=None,\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=polar_sdk.Product(\n id=\"\",\n created_at=parse_datetime(\"2024-11-20T03:32:58.538Z\"),\n modified_at=parse_datetime(\"2026-11-18T20:34:51.217Z\"),\n trial_interval=polar_sdk.TrialInterval.MONTH,\n trial_interval_count=995549,\n name=\"\",\n description=\"properly peter ferociously clearly inwardly zowie guacamole boohoo hairy\",\n visibility=polar_sdk.ProductVisibility.DRAFT,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,\n recurring_interval_count=385570,\n is_recurring=False,\n is_archived=False,\n organization_id=\"\",\n metadata={\n\n },\n prices=[\n polar_sdk.LegacyRecurringProductPriceCustom(\n created_at=parse_datetime(\"2024-06-27T09:20:21.441Z\"),\n modified_at=parse_datetime(\"2026-03-12T21:29:58.020Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n is_archived=True,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,\n minimum_amount=272121,\n maximum_amount=32558,\n preset_amount=876063,\n ),\n ],\n benefits=[\n polar_sdk.BenefitCustom(\n id=\"\",\n created_at=parse_datetime(\"2024-03-17T04:39:43.339Z\"),\n modified_at=parse_datetime(\"2026-12-15T00:09:56.151Z\"),\n description=\"whose hydrolyse blight iterate\",\n selectable=False,\n deletable=False,\n organization_id=\"\",\n metadata={\n\n },\n properties=polar_sdk.BenefitCustomProperties(\n note=\"\",\n ),\n ),\n ],\n medias=[\n polar_sdk.ProductMediaFileRead(\n id=\"\",\n organization_id=\"\",\n name=\"\",\n path=\"/sbin\",\n mime_type=\"\",\n size=947289,\n storage_version=\"\",\n checksum_etag=\"\",\n checksum_sha256_base64=\"\",\n checksum_sha256_hex=\"\",\n last_modified_at=parse_datetime(\"2024-02-23T16:15:56.302Z\"),\n version=\"\",\n is_uploaded=True,\n created_at=parse_datetime(\"2024-03-25T18:54:21.294Z\"),\n size_readable=\"\",\n public_url=\"https://winged-violin.name/\",\n ),\n ],\n attached_custom_fields=[\n polar_sdk.AttachedCustomField(\n custom_field_id=\"\",\n custom_field=polar_sdk.CustomFieldDate(\n created_at=parse_datetime(\"2025-08-27T10:01:22.801Z\"),\n modified_at=None,\n id=\"\",\n metadata={\n \"key\": \"\",\n },\n slug=\"\",\n name=\"\",\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n properties=polar_sdk.CustomFieldDateProperties(),\n ),\n order=525746,\n required=True,\n ),\n ],\n ),\n discount=polar_sdk.DiscountPercentageRepeatDurationBase(\n duration=polar_sdk.DiscountDuration.REPEATING,\n duration_in_months=593089,\n type=polar_sdk.DiscountType.FIXED,\n basis_points=1000,\n created_at=parse_datetime(\"2025-07-05T22:39:40.587Z\"),\n modified_at=None,\n id=\"\",\n metadata={\n \"key\": 1299.91,\n },\n name=\"\",\n code=\"\",\n starts_at=parse_datetime(\"2025-10-19T03:25:19.055Z\"),\n ends_at=parse_datetime(\"2025-06-12T02:19:51.674Z\"),\n max_redemptions=646635,\n redemptions_count=522713,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n prices=[],\n meters=[\n polar_sdk.SubscriptionMeter(\n created_at=parse_datetime(\"2024-01-05T08:39:41.453Z\"),\n modified_at=parse_datetime(\"2024-10-07T16:35:26.200Z\"),\n id=\"\",\n consumed_units=25,\n credited_units=100,\n amount=0,\n meter_id=\"d498a884-e2cd-4d3e-8002-f536468a8b22\",\n meter=polar_sdk.Meter(\n metadata={\n\n },\n created_at=parse_datetime(\"2025-01-08T17:20:07.038Z\"),\n modified_at=parse_datetime(\"2024-05-24T19:24:48.891Z\"),\n id=\"\",\n name=\"\",\n filter_=polar_sdk.Filter(\n conjunction=polar_sdk.FilterConjunction.OR,\n clauses=[],\n ),\n aggregation=polar_sdk.UniqueAggregation(\n property=\"\",\n ),\n organization_id=\"\",\n ),\n ),\n ],\n ),\n ))\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointsubscription_past_due_post(request=polar_sdk.WebhookSubscriptionPastDuePayload(\n timestamp=parse_datetime(\"2025-08-08T08:08:34.879Z\"),\n data=polar_sdk.Subscription(\n created_at=parse_datetime(\"2025-08-04T16:17:07.577Z\"),\n modified_at=parse_datetime(\"2025-12-31T22:57:08.265Z\"),\n id=\"\",\n amount=10000,\n currency=\"usd\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.WEEK,\n recurring_interval_count=546644,\n status=polar_sdk.SubscriptionStatus.PAST_DUE,\n current_period_start=parse_datetime(\"2025-11-30T09:38:02.409Z\"),\n current_period_end=parse_datetime(\"2025-09-12T10:41:08.869Z\"),\n trial_start=parse_datetime(\"2025-04-18T01:48:54.159Z\"),\n trial_end=parse_datetime(\"2026-12-17T23:19:51.561Z\"),\n cancel_at_period_end=False,\n canceled_at=parse_datetime(\"2026-03-24T06:54:09.981Z\"),\n started_at=parse_datetime(\"2026-07-30T18:40:35.200Z\"),\n ends_at=parse_datetime(\"2026-05-14T09:53:26.015Z\"),\n ended_at=parse_datetime(\"2025-05-26T17:14:22.064Z\"),\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n checkout_id=\"\",\n customer_cancellation_reason=polar_sdk.CustomerCancellationReason.OTHER,\n customer_cancellation_comment=None,\n metadata={\n\n },\n customer=polar_sdk.SubscriptionCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2026-04-22T03:52:11.592Z\"),\n modified_at=parse_datetime(\"2024-04-06T18:32:38.832Z\"),\n metadata={\n\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=None,\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=polar_sdk.Product(\n id=\"\",\n created_at=parse_datetime(\"2024-11-20T03:32:58.538Z\"),\n modified_at=parse_datetime(\"2026-11-18T20:34:51.217Z\"),\n trial_interval=polar_sdk.TrialInterval.MONTH,\n trial_interval_count=995549,\n name=\"\",\n description=\"properly peter ferociously clearly inwardly zowie guacamole boohoo hairy\",\n visibility=polar_sdk.ProductVisibility.DRAFT,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,\n recurring_interval_count=385570,\n is_recurring=False,\n is_archived=False,\n organization_id=\"\",\n metadata={\n\n },\n prices=[\n polar_sdk.LegacyRecurringProductPriceCustom(\n created_at=parse_datetime(\"2024-06-27T09:20:21.441Z\"),\n modified_at=parse_datetime(\"2026-03-12T21:29:58.020Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n tax_behavior=polar_sdk.TaxBehaviorOption.LOCATION,\n is_archived=False,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,\n minimum_amount=32558,\n maximum_amount=876063,\n preset_amount=807,\n ),\n ],\n benefits=[],\n medias=[],\n attached_custom_fields=[\n polar_sdk.AttachedCustomField(\n custom_field_id=\"\",\n custom_field=polar_sdk.CustomFieldDate(\n created_at=parse_datetime(\"2026-11-01T05:33:56.827Z\"),\n modified_at=parse_datetime(\"2024-10-23T05:01:55.870Z\"),\n id=\"\",\n metadata={\n\n },\n slug=\"\",\n name=\"\",\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n properties=polar_sdk.CustomFieldDateProperties(),\n ),\n order=549034,\n required=True,\n ),\n ],\n ),\n discount=polar_sdk.DiscountPercentageOnceForeverDurationBase(\n duration=polar_sdk.DiscountDuration.ONCE,\n type=polar_sdk.DiscountType.FIXED,\n basis_points=1000,\n created_at=parse_datetime(\"2025-06-10T14:06:47.349Z\"),\n modified_at=parse_datetime(\"2026-06-13T23:17:16.972Z\"),\n id=\"\",\n metadata={\n\n },\n name=\"\",\n code=\"\",\n starts_at=parse_datetime(\"2024-12-22T18:39:04.300Z\"),\n ends_at=parse_datetime(\"2026-01-19T02:15:00.076Z\"),\n max_redemptions=83929,\n redemptions_count=552700,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n prices=[\n polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2026-06-14T11:58:24.543Z\"),\n modified_at=parse_datetime(\"2025-05-14T23:34:45.104Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n tax_behavior=polar_sdk.TaxBehaviorOption.LOCATION,\n is_archived=True,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,\n price_amount=962073,\n ),\n ],\n meters=[\n polar_sdk.SubscriptionMeter(\n created_at=parse_datetime(\"2026-11-04T05:28:57.546Z\"),\n modified_at=parse_datetime(\"2025-04-16T02:50:26.454Z\"),\n id=\"\",\n consumed_units=25,\n credited_units=100,\n amount=0,\n meter_id=\"d498a884-e2cd-4d3e-8002-f536468a8b22\",\n meter=polar_sdk.Meter(\n metadata={\n \"key\": True,\n },\n created_at=parse_datetime(\"2024-02-23T16:15:56.302Z\"),\n modified_at=parse_datetime(\"2024-05-31T02:39:29.944Z\"),\n id=\"\",\n name=\"\",\n filter_=polar_sdk.Filter(\n conjunction=polar_sdk.FilterConjunction.AND,\n clauses=[],\n ),\n aggregation=polar_sdk.UniqueAggregation(\n property=\"\",\n ),\n organization_id=\"\",\n ),\n ),\n ],\n pending_update=polar_sdk.PendingSubscriptionUpdate(\n created_at=parse_datetime(\"2025-08-31T21:49:39.009Z\"),\n modified_at=parse_datetime(\"2024-11-12T02:50:26.409Z\"),\n id=\"\",\n applies_at=parse_datetime(\"2025-08-27T10:01:22.801Z\"),\n product_id=None,\n seats=41957,\n ),\n ),\n ))\n\n # Handle response\n print(res)" - target: $["paths"]["subscription.revoked"]["post"] update: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointsubscription_revoked_post(request=polar_sdk.WebhookSubscriptionRevokedPayload(\n timestamp=parse_datetime(\"2025-01-01T06:40:50.860Z\"),\n data=polar_sdk.Subscription(\n created_at=parse_datetime(\"2024-03-15T08:42:29.566Z\"),\n modified_at=parse_datetime(\"2024-10-27T01:20:21.930Z\"),\n id=\"\",\n amount=10000,\n currency=\"usd\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n recurring_interval_count=811590,\n status=polar_sdk.SubscriptionStatus.ACTIVE,\n current_period_start=parse_datetime(\"2024-05-29T02:07:20.021Z\"),\n current_period_end=parse_datetime(\"2026-03-19T11:29:47.842Z\"),\n trial_start=parse_datetime(\"2024-11-19T08:24:19.529Z\"),\n trial_end=None,\n cancel_at_period_end=False,\n canceled_at=parse_datetime(\"2026-06-25T06:14:56.835Z\"),\n started_at=parse_datetime(\"2024-11-12T16:37:04.348Z\"),\n ends_at=parse_datetime(\"2024-12-27T07:35:48.028Z\"),\n ended_at=parse_datetime(\"2025-01-25T10:24:50.250Z\"),\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n checkout_id=\"\",\n customer_cancellation_reason=polar_sdk.CustomerCancellationReason.MISSING_FEATURES,\n customer_cancellation_comment=\"\",\n metadata={\n \"key\": False,\n },\n customer=polar_sdk.SubscriptionCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2025-11-12T05:10:40.368Z\"),\n modified_at=parse_datetime(\"2025-05-28T06:09:58.228Z\"),\n metadata={\n\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2024-07-13T08:43:45.509Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=polar_sdk.Product(\n id=\"\",\n created_at=parse_datetime(\"2026-12-09T13:41:39.970Z\"),\n modified_at=parse_datetime(\"2026-06-26T05:35:27.950Z\"),\n trial_interval=polar_sdk.TrialInterval.WEEK,\n trial_interval_count=304056,\n name=\"\",\n description=\"apparatus since acidly anti canter dimly\",\n visibility=polar_sdk.ProductVisibility.PRIVATE,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.WEEK,\n recurring_interval_count=751397,\n is_recurring=False,\n is_archived=True,\n organization_id=\"\",\n metadata={\n \"key\": 3874.54,\n },\n prices=[\n polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2024-03-20T15:58:14.460Z\"),\n modified_at=parse_datetime(\"2025-02-27T20:05:06.103Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.CATALOG,\n price_currency=\"\",\n is_archived=False,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n price_amount=318678,\n ),\n ],\n benefits=[],\n medias=[],\n attached_custom_fields=[],\n ),\n discount=None,\n prices=[\n polar_sdk.LegacyRecurringProductPriceFree(\n created_at=parse_datetime(\"2026-11-28T05:50:39.876Z\"),\n modified_at=parse_datetime(\"2024-01-18T23:12:00.000Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.CATALOG,\n price_currency=\"\",\n is_archived=True,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.WEEK,\n ),\n ],\n meters=[\n polar_sdk.SubscriptionMeter(\n created_at=parse_datetime(\"2025-04-18T08:50:27.677Z\"),\n modified_at=None,\n id=\"\",\n consumed_units=25,\n credited_units=100,\n amount=0,\n meter_id=\"d498a884-e2cd-4d3e-8002-f536468a8b22\",\n meter=polar_sdk.Meter(\n metadata={\n \"key\": \"\",\n },\n created_at=parse_datetime(\"2025-09-25T01:56:13.871Z\"),\n modified_at=parse_datetime(\"2026-12-06T00:32:34.639Z\"),\n id=\"\",\n name=\"\",\n filter_=polar_sdk.Filter(\n conjunction=polar_sdk.FilterConjunction.AND,\n clauses=[],\n ),\n aggregation=polar_sdk.CountAggregation(),\n organization_id=\"\",\n ),\n ),\n ],\n ),\n ))\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointsubscription_revoked_post(request=polar_sdk.WebhookSubscriptionRevokedPayload(\n timestamp=parse_datetime(\"2025-01-01T06:40:50.860Z\"),\n data=polar_sdk.Subscription(\n created_at=parse_datetime(\"2024-03-15T08:42:29.566Z\"),\n modified_at=parse_datetime(\"2024-10-27T01:20:21.930Z\"),\n id=\"\",\n amount=10000,\n currency=\"usd\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.DAY,\n recurring_interval_count=811590,\n status=polar_sdk.SubscriptionStatus.ACTIVE,\n current_period_start=parse_datetime(\"2024-05-29T02:07:20.021Z\"),\n current_period_end=parse_datetime(\"2026-03-19T11:29:47.842Z\"),\n trial_start=parse_datetime(\"2024-11-19T08:24:19.529Z\"),\n trial_end=None,\n cancel_at_period_end=False,\n canceled_at=parse_datetime(\"2026-06-25T06:14:56.835Z\"),\n started_at=parse_datetime(\"2024-11-12T16:37:04.348Z\"),\n ends_at=parse_datetime(\"2024-12-27T07:35:48.028Z\"),\n ended_at=parse_datetime(\"2025-01-25T10:24:50.250Z\"),\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n checkout_id=\"\",\n customer_cancellation_reason=polar_sdk.CustomerCancellationReason.MISSING_FEATURES,\n customer_cancellation_comment=\"\",\n metadata={\n \"key\": False,\n },\n customer=polar_sdk.SubscriptionCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2025-11-12T05:10:40.368Z\"),\n modified_at=parse_datetime(\"2025-05-28T06:09:58.228Z\"),\n metadata={\n\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2024-07-13T08:43:45.509Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=polar_sdk.Product(\n id=\"\",\n created_at=parse_datetime(\"2026-12-09T13:41:39.970Z\"),\n modified_at=parse_datetime(\"2026-06-26T05:35:27.950Z\"),\n trial_interval=polar_sdk.TrialInterval.WEEK,\n trial_interval_count=304056,\n name=\"\",\n description=\"apparatus since acidly anti canter dimly\",\n visibility=polar_sdk.ProductVisibility.PRIVATE,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.WEEK,\n recurring_interval_count=751397,\n is_recurring=False,\n is_archived=True,\n organization_id=\"\",\n metadata={\n \"key\": 3874.54,\n },\n prices=[\n polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2024-03-20T15:58:14.460Z\"),\n modified_at=parse_datetime(\"2025-02-27T20:05:06.103Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.CATALOG,\n price_currency=\"\",\n tax_behavior=polar_sdk.TaxBehaviorOption.LOCATION,\n is_archived=True,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.WEEK,\n price_amount=496524,\n ),\n ],\n benefits=[],\n medias=[],\n attached_custom_fields=[\n polar_sdk.AttachedCustomField(\n custom_field_id=\"\",\n custom_field=polar_sdk.CustomFieldText(\n created_at=parse_datetime(\"2025-04-14T21:10:01.890Z\"),\n modified_at=parse_datetime(\"2024-05-08T16:38:05.908Z\"),\n id=\"\",\n metadata={\n\n },\n slug=\"\",\n name=\"\",\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n properties=polar_sdk.CustomFieldTextProperties(),\n ),\n order=85609,\n required=True,\n ),\n ],\n ),\n discount=polar_sdk.DiscountFixedRepeatDurationBase(\n duration=polar_sdk.DiscountDuration.ONCE,\n duration_in_months=980614,\n type=polar_sdk.DiscountType.FIXED,\n amount=1000,\n currency=\"usd\",\n amounts={\n \"eur\": 900,\n \"usd\": 1000,\n },\n created_at=parse_datetime(\"2025-09-25T01:56:13.871Z\"),\n modified_at=parse_datetime(\"2026-12-06T00:32:34.639Z\"),\n id=\"\",\n metadata={\n\n },\n name=\"\",\n code=\"\",\n starts_at=parse_datetime(\"2026-03-02T20:38:11.072Z\"),\n ends_at=parse_datetime(\"2024-08-13T14:20:32.573Z\"),\n max_redemptions=218996,\n redemptions_count=391070,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n prices=[\n polar_sdk.LegacyRecurringProductPriceFree(\n created_at=parse_datetime(\"2024-10-23T02:23:13.563Z\"),\n modified_at=parse_datetime(\"2024-01-18T21:14:41.001Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.CATALOG,\n price_currency=\"\",\n tax_behavior=polar_sdk.TaxBehaviorOption.LOCATION,\n is_archived=False,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,\n ),\n ],\n meters=[\n polar_sdk.SubscriptionMeter(\n created_at=parse_datetime(\"2024-01-11T16:00:45.196Z\"),\n modified_at=None,\n id=\"\",\n consumed_units=25,\n credited_units=100,\n amount=0,\n meter_id=\"d498a884-e2cd-4d3e-8002-f536468a8b22\",\n meter=polar_sdk.Meter(\n metadata={\n \"key\": 5814.55,\n },\n created_at=parse_datetime(\"2026-05-01T00:37:33.140Z\"),\n modified_at=parse_datetime(\"2025-05-06T17:26:09.493Z\"),\n id=\"\",\n name=\"\",\n filter_=polar_sdk.Filter(\n conjunction=polar_sdk.FilterConjunction.AND,\n clauses=[\n polar_sdk.Filter(\n conjunction=polar_sdk.FilterConjunction.OR,\n clauses=[],\n ),\n ],\n ),\n aggregation=polar_sdk.UniqueAggregation(\n property=\"\",\n ),\n organization_id=\"\",\n ),\n ),\n ],\n pending_update=None,\n ),\n ))\n\n # Handle response\n print(res)" - target: $["paths"]["subscription.uncanceled"]["post"] update: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointsubscription_uncanceled_post(request=polar_sdk.WebhookSubscriptionUncanceledPayload(\n timestamp=parse_datetime(\"2024-02-06T17:25:10.106Z\"),\n data=polar_sdk.Subscription(\n created_at=parse_datetime(\"2024-05-12T11:53:26.507Z\"),\n modified_at=None,\n id=\"\",\n amount=10000,\n currency=\"usd\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.YEAR,\n recurring_interval_count=406654,\n status=polar_sdk.SubscriptionStatus.INCOMPLETE_EXPIRED,\n current_period_start=parse_datetime(\"2026-06-06T02:06:49.326Z\"),\n current_period_end=parse_datetime(\"2025-04-11T19:08:16.655Z\"),\n trial_start=parse_datetime(\"2024-08-22T01:03:59.107Z\"),\n trial_end=parse_datetime(\"2025-08-30T15:34:10.479Z\"),\n cancel_at_period_end=False,\n canceled_at=None,\n started_at=parse_datetime(\"2024-12-22T04:50:00.016Z\"),\n ends_at=parse_datetime(\"2025-10-18T16:25:47.209Z\"),\n ended_at=parse_datetime(\"2024-01-21T06:39:24.599Z\"),\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n checkout_id=\"\",\n customer_cancellation_reason=polar_sdk.CustomerCancellationReason.CUSTOMER_SERVICE,\n customer_cancellation_comment=\"\",\n metadata={\n\n },\n customer=polar_sdk.SubscriptionCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2025-07-04T17:30:56.477Z\"),\n modified_at=parse_datetime(\"2025-12-23T09:30:11.195Z\"),\n metadata={\n\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2025-07-11T02:50:51.350Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=polar_sdk.Product(\n id=\"\",\n created_at=parse_datetime(\"2025-05-11T18:08:21.251Z\"),\n modified_at=parse_datetime(\"2025-10-15T19:47:04.648Z\"),\n trial_interval=polar_sdk.TrialInterval.MONTH,\n trial_interval_count=709373,\n name=\"\",\n description=\"but next inasmuch without as sway\",\n visibility=polar_sdk.ProductVisibility.PRIVATE,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.WEEK,\n recurring_interval_count=297960,\n is_recurring=True,\n is_archived=True,\n organization_id=\"\",\n metadata={\n\n },\n prices=[\n polar_sdk.ProductPriceSeatBased(\n created_at=parse_datetime(\"2024-09-21T18:28:22.579Z\"),\n modified_at=parse_datetime(\"2025-07-31T06:17:31.367Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n is_archived=False,\n product_id=\"\",\n seat_tiers=polar_sdk.ProductPriceSeatTiersOutput(\n tiers=[\n polar_sdk.ProductPriceSeatTier(\n min_seats=917275,\n price_per_seat=511396,\n ),\n ],\n minimum_seats=2933,\n maximum_seats=200423,\n ),\n ),\n ],\n benefits=[],\n medias=[\n polar_sdk.ProductMediaFileRead(\n id=\"\",\n organization_id=\"\",\n name=\"\",\n path=\"/opt/share\",\n mime_type=\"\",\n size=508912,\n storage_version=\"\",\n checksum_etag=\"\",\n checksum_sha256_base64=\"\",\n checksum_sha256_hex=None,\n last_modified_at=None,\n version=\"\",\n is_uploaded=False,\n created_at=parse_datetime(\"2025-03-24T21:29:58.344Z\"),\n size_readable=\"\",\n public_url=\"https://nautical-custody.net/\",\n ),\n ],\n attached_custom_fields=[],\n ),\n discount=polar_sdk.DiscountFixedOnceForeverDurationBase(\n duration=polar_sdk.DiscountDuration.ONCE,\n type=polar_sdk.DiscountType.PERCENTAGE,\n amount=1000,\n currency=\"usd\",\n amounts={\n \"eur\": 900,\n \"usd\": 1000,\n },\n created_at=parse_datetime(\"2024-11-15T06:03:06.144Z\"),\n modified_at=parse_datetime(\"2025-08-25T04:34:39.417Z\"),\n id=\"\",\n metadata={\n \"key\": 9734.94,\n },\n name=\"\",\n code=None,\n starts_at=parse_datetime(\"2025-05-06T12:58:19.237Z\"),\n ends_at=parse_datetime(\"2025-06-19T01:32:05.669Z\"),\n max_redemptions=533137,\n redemptions_count=786469,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n prices=[],\n meters=[\n polar_sdk.SubscriptionMeter(\n created_at=parse_datetime(\"2024-07-20T17:23:38.700Z\"),\n modified_at=parse_datetime(\"2026-06-18T19:23:29.003Z\"),\n id=\"\",\n consumed_units=25,\n credited_units=100,\n amount=0,\n meter_id=\"d498a884-e2cd-4d3e-8002-f536468a8b22\",\n meter=polar_sdk.Meter(\n metadata={\n \"key\": \"\",\n },\n created_at=parse_datetime(\"2025-11-26T22:20:03.421Z\"),\n modified_at=parse_datetime(\"2024-01-27T13:13:52.293Z\"),\n id=\"\",\n name=\"\",\n filter_=polar_sdk.Filter(\n conjunction=polar_sdk.FilterConjunction.AND,\n clauses=[],\n ),\n aggregation=polar_sdk.CountAggregation(),\n organization_id=\"\",\n ),\n ),\n ],\n ),\n ))\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointsubscription_uncanceled_post(request=polar_sdk.WebhookSubscriptionUncanceledPayload(\n timestamp=parse_datetime(\"2024-02-06T17:25:10.106Z\"),\n data=polar_sdk.Subscription(\n created_at=parse_datetime(\"2024-05-12T11:53:26.507Z\"),\n modified_at=None,\n id=\"\",\n amount=10000,\n currency=\"usd\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.YEAR,\n recurring_interval_count=406654,\n status=polar_sdk.SubscriptionStatus.INCOMPLETE_EXPIRED,\n current_period_start=parse_datetime(\"2026-06-06T02:06:49.326Z\"),\n current_period_end=parse_datetime(\"2025-04-11T19:08:16.655Z\"),\n trial_start=parse_datetime(\"2024-08-22T01:03:59.107Z\"),\n trial_end=parse_datetime(\"2025-08-30T15:34:10.479Z\"),\n cancel_at_period_end=False,\n canceled_at=None,\n started_at=parse_datetime(\"2024-12-22T04:50:00.016Z\"),\n ends_at=parse_datetime(\"2025-10-18T16:25:47.209Z\"),\n ended_at=parse_datetime(\"2024-01-21T06:39:24.599Z\"),\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n checkout_id=\"\",\n customer_cancellation_reason=polar_sdk.CustomerCancellationReason.CUSTOMER_SERVICE,\n customer_cancellation_comment=\"\",\n metadata={\n\n },\n customer=polar_sdk.SubscriptionCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2025-07-04T17:30:56.477Z\"),\n modified_at=parse_datetime(\"2025-12-23T09:30:11.195Z\"),\n metadata={\n\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2025-07-11T02:50:51.350Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=polar_sdk.Product(\n id=\"\",\n created_at=parse_datetime(\"2025-05-11T18:08:21.251Z\"),\n modified_at=parse_datetime(\"2025-10-15T19:47:04.648Z\"),\n trial_interval=polar_sdk.TrialInterval.MONTH,\n trial_interval_count=709373,\n name=\"\",\n description=\"but next inasmuch without as sway\",\n visibility=polar_sdk.ProductVisibility.PRIVATE,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.WEEK,\n recurring_interval_count=297960,\n is_recurring=True,\n is_archived=True,\n organization_id=\"\",\n metadata={\n\n },\n prices=[\n polar_sdk.ProductPriceSeatBased(\n created_at=parse_datetime(\"2024-09-21T18:28:22.579Z\"),\n modified_at=parse_datetime(\"2025-07-31T06:17:31.367Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n tax_behavior=polar_sdk.TaxBehaviorOption.INCLUSIVE,\n is_archived=False,\n product_id=\"\",\n seat_tiers=polar_sdk.ProductPriceSeatTiersOutput(\n tiers=[\n polar_sdk.ProductPriceSeatTier(\n min_seats=2933,\n price_per_seat=163180,\n ),\n ],\n minimum_seats=200423,\n maximum_seats=879068,\n ),\n ),\n ],\n benefits=[],\n medias=[\n polar_sdk.ProductMediaFileRead(\n id=\"\",\n organization_id=\"\",\n name=\"\",\n path=\"/lib\",\n mime_type=\"\",\n size=141167,\n storage_version=\"\",\n checksum_etag=None,\n checksum_sha256_base64=None,\n checksum_sha256_hex=\"\",\n last_modified_at=parse_datetime(\"2025-03-24T21:29:58.344Z\"),\n version=\"\",\n is_uploaded=False,\n created_at=parse_datetime(\"2024-08-20T14:44:29.354Z\"),\n size_readable=\"\",\n public_url=\"https://dazzling-entry.com\",\n ),\n ],\n attached_custom_fields=[],\n ),\n discount=polar_sdk.DiscountFixedRepeatDurationBase(\n duration=polar_sdk.DiscountDuration.FOREVER,\n duration_in_months=549444,\n type=polar_sdk.DiscountType.PERCENTAGE,\n amount=1000,\n currency=\"usd\",\n amounts={\n \"eur\": 900,\n \"usd\": 1000,\n },\n created_at=parse_datetime(\"2025-09-10T10:32:32.710Z\"),\n modified_at=parse_datetime(\"2024-01-25T07:05:16.396Z\"),\n id=\"\",\n metadata={\n\n },\n name=\"\",\n code=\"\",\n starts_at=parse_datetime(\"2025-06-19T01:32:05.669Z\"),\n ends_at=parse_datetime(\"2025-08-07T07:38:27.510Z\"),\n max_redemptions=409446,\n redemptions_count=945633,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n prices=[],\n meters=[\n polar_sdk.SubscriptionMeter(\n created_at=parse_datetime(\"2026-06-18T19:23:29.003Z\"),\n modified_at=parse_datetime(\"2024-01-05T01:01:18.756Z\"),\n id=\"\",\n consumed_units=25,\n credited_units=100,\n amount=0,\n meter_id=\"d498a884-e2cd-4d3e-8002-f536468a8b22\",\n meter=polar_sdk.Meter(\n metadata={\n \"key\": \"\",\n },\n created_at=parse_datetime(\"2024-01-27T13:13:52.293Z\"),\n modified_at=parse_datetime(\"2024-05-31T04:28:19.613Z\"),\n id=\"\",\n name=\"\",\n filter_=polar_sdk.Filter(\n conjunction=polar_sdk.FilterConjunction.AND,\n clauses=[],\n ),\n aggregation=polar_sdk.PropertyAggregation(\n func=polar_sdk.Func.MIN,\n property=\"\",\n ),\n organization_id=\"\",\n ),\n ),\n ],\n pending_update=polar_sdk.PendingSubscriptionUpdate(\n created_at=parse_datetime(\"2025-01-19T03:27:59.475Z\"),\n modified_at=None,\n id=\"\",\n applies_at=parse_datetime(\"2026-07-09T15:02:17.613Z\"),\n product_id=\"\",\n seats=65628,\n ),\n ),\n ))\n\n # Handle response\n print(res)" - target: $["paths"]["subscription.updated"]["post"] update: "x-codeSamples": - "lang": "python" "label": "Python (SDK)" - "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointsubscription_updated_post(request=polar_sdk.WebhookSubscriptionUpdatedPayload(\n timestamp=parse_datetime(\"2024-06-23T13:26:25.969Z\"),\n data=polar_sdk.Subscription(\n created_at=parse_datetime(\"2025-05-25T12:11:24.717Z\"),\n modified_at=parse_datetime(\"2025-07-08T02:17:23.799Z\"),\n id=\"\",\n amount=10000,\n currency=\"usd\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.WEEK,\n recurring_interval_count=489836,\n status=polar_sdk.SubscriptionStatus.CANCELED,\n current_period_start=parse_datetime(\"2025-06-19T12:29:28.503Z\"),\n current_period_end=parse_datetime(\"2024-06-13T15:07:05.619Z\"),\n trial_start=parse_datetime(\"2026-04-17T18:51:57.213Z\"),\n trial_end=parse_datetime(\"2026-08-31T06:08:08.476Z\"),\n cancel_at_period_end=False,\n canceled_at=parse_datetime(\"2025-10-12T01:39:46.850Z\"),\n started_at=parse_datetime(\"2025-08-23T08:17:41.246Z\"),\n ends_at=parse_datetime(\"2026-04-28T14:07:35.212Z\"),\n ended_at=parse_datetime(\"2026-04-23T18:41:38.111Z\"),\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n checkout_id=\"\",\n customer_cancellation_reason=polar_sdk.CustomerCancellationReason.MISSING_FEATURES,\n customer_cancellation_comment=\"\",\n metadata={\n \"key\": 384298,\n },\n customer=polar_sdk.SubscriptionCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2025-06-15T22:53:11.971Z\"),\n modified_at=parse_datetime(\"2025-03-20T00:06:47.924Z\"),\n metadata={\n\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.CountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2024-05-09T07:26:17.258Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=polar_sdk.Product(\n id=\"\",\n created_at=parse_datetime(\"2025-08-19T16:06:29.687Z\"),\n modified_at=parse_datetime(\"2026-06-13T05:20:06.893Z\"),\n trial_interval=polar_sdk.TrialInterval.YEAR,\n trial_interval_count=201327,\n name=\"\",\n description=\"disbar athwart permafrost happy\",\n visibility=polar_sdk.ProductVisibility.DRAFT,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,\n recurring_interval_count=378464,\n is_recurring=False,\n is_archived=False,\n organization_id=\"\",\n metadata={\n \"key\": 6443,\n },\n prices=[\n polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2026-05-04T05:53:46.911Z\"),\n modified_at=parse_datetime(\"2025-04-20T10:56:36.752Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n is_archived=True,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.YEAR,\n price_amount=951036,\n ),\n ],\n benefits=[\n polar_sdk.BenefitMeterCredit(\n id=\"\",\n created_at=parse_datetime(\"2024-11-29T16:10:57.194Z\"),\n modified_at=parse_datetime(\"2025-08-11T02:28:22.156Z\"),\n description=\"than circumnavigate supposing incidentally instructor responsibility\",\n selectable=False,\n deletable=False,\n organization_id=\"\",\n metadata={\n\n },\n properties=polar_sdk.BenefitMeterCreditProperties(\n units=962223,\n rollover=True,\n meter_id=\"\",\n ),\n ),\n ],\n medias=[\n polar_sdk.ProductMediaFileRead(\n id=\"\",\n organization_id=\"\",\n name=\"\",\n path=\"/opt/bin\",\n mime_type=\"\",\n size=436642,\n storage_version=None,\n checksum_etag=\"\",\n checksum_sha256_base64=\"\",\n checksum_sha256_hex=\"\",\n last_modified_at=parse_datetime(\"2025-12-22T09:16:00.139Z\"),\n version=None,\n is_uploaded=False,\n created_at=parse_datetime(\"2026-06-07T13:44:19.881Z\"),\n size_readable=\"\",\n public_url=\"https://gaseous-vein.info/\",\n ),\n ],\n attached_custom_fields=[],\n ),\n discount=polar_sdk.DiscountPercentageOnceForeverDurationBase(\n duration=polar_sdk.DiscountDuration.FOREVER,\n type=polar_sdk.DiscountType.FIXED,\n basis_points=1000,\n created_at=parse_datetime(\"2024-05-20T02:26:27.963Z\"),\n modified_at=parse_datetime(\"2026-06-09T17:54:52.162Z\"),\n id=\"\",\n metadata={\n\n },\n name=\"\",\n code=\"\",\n starts_at=parse_datetime(\"2025-12-16T20:50:35.317Z\"),\n ends_at=parse_datetime(\"2024-05-26T19:23:38.918Z\"),\n max_redemptions=102380,\n redemptions_count=914713,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n prices=[],\n meters=[],\n ),\n ))\n\n # Handle response\n print(res)" + "source": "import polar_sdk\nfrom polar_sdk import Polar\nfrom polar_sdk.utils import parse_datetime\n\n\nwith Polar() as polar:\n\n res = polar.endpointsubscription_updated_post(request=polar_sdk.WebhookSubscriptionUpdatedPayload(\n timestamp=parse_datetime(\"2024-06-23T13:26:25.969Z\"),\n data=polar_sdk.Subscription(\n created_at=parse_datetime(\"2025-05-25T12:11:24.717Z\"),\n modified_at=parse_datetime(\"2025-07-08T02:17:23.799Z\"),\n id=\"\",\n amount=10000,\n currency=\"usd\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.WEEK,\n recurring_interval_count=489836,\n status=polar_sdk.SubscriptionStatus.CANCELED,\n current_period_start=parse_datetime(\"2025-06-19T12:29:28.503Z\"),\n current_period_end=parse_datetime(\"2024-06-13T15:07:05.619Z\"),\n trial_start=parse_datetime(\"2026-04-17T18:51:57.213Z\"),\n trial_end=parse_datetime(\"2026-08-31T06:08:08.476Z\"),\n cancel_at_period_end=False,\n canceled_at=parse_datetime(\"2025-10-12T01:39:46.850Z\"),\n started_at=parse_datetime(\"2025-08-23T08:17:41.246Z\"),\n ends_at=parse_datetime(\"2026-04-28T14:07:35.212Z\"),\n ended_at=parse_datetime(\"2026-04-23T18:41:38.111Z\"),\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n checkout_id=\"\",\n customer_cancellation_reason=polar_sdk.CustomerCancellationReason.MISSING_FEATURES,\n customer_cancellation_comment=\"\",\n metadata={\n \"key\": 384298,\n },\n customer=polar_sdk.SubscriptionCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2025-06-15T22:53:11.971Z\"),\n modified_at=parse_datetime(\"2025-03-20T00:06:47.924Z\"),\n metadata={\n\n },\n external_id=\"usr_1337\",\n email=\"customer@example.com\",\n email_verified=True,\n type=polar_sdk.CustomerType.INDIVIDUAL,\n name=\"John Doe\",\n billing_address=polar_sdk.Address(\n country=polar_sdk.AddressCountryAlpha2.US,\n ),\n tax_id=[\n \"911144442\",\n \"us_ein\",\n ],\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n deleted_at=parse_datetime(\"2024-05-09T07:26:17.258Z\"),\n avatar_url=\"https://www.gravatar.com/avatar/xxx?d=404\",\n ),\n product=polar_sdk.Product(\n id=\"\",\n created_at=parse_datetime(\"2025-08-19T16:06:29.687Z\"),\n modified_at=parse_datetime(\"2026-06-13T05:20:06.893Z\"),\n trial_interval=polar_sdk.TrialInterval.YEAR,\n trial_interval_count=201327,\n name=\"\",\n description=\"disbar athwart permafrost happy\",\n visibility=polar_sdk.ProductVisibility.DRAFT,\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.MONTH,\n recurring_interval_count=378464,\n is_recurring=False,\n is_archived=False,\n organization_id=\"\",\n metadata={\n \"key\": 6443,\n },\n prices=[\n polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2026-05-04T05:53:46.911Z\"),\n modified_at=parse_datetime(\"2025-04-20T10:56:36.752Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.AD_HOC,\n price_currency=\"\",\n tax_behavior=polar_sdk.TaxBehaviorOption.EXCLUSIVE,\n is_archived=False,\n product_id=\"\",\n recurring_interval=polar_sdk.SubscriptionRecurringInterval.YEAR,\n price_amount=946217,\n ),\n ],\n benefits=[],\n medias=[\n polar_sdk.ProductMediaFileRead(\n id=\"\",\n organization_id=\"\",\n name=\"\",\n path=\"/root\",\n mime_type=\"\",\n size=425766,\n storage_version=\"\",\n checksum_etag=\"\",\n checksum_sha256_base64=\"\",\n checksum_sha256_hex=None,\n last_modified_at=parse_datetime(\"2024-12-02T14:42:17.472Z\"),\n version=\"\",\n is_uploaded=False,\n created_at=parse_datetime(\"2024-09-01T08:42:27.221Z\"),\n size_readable=\"\",\n public_url=\"https://partial-allegation.name\",\n ),\n ],\n attached_custom_fields=[],\n ),\n discount=polar_sdk.DiscountFixedOnceForeverDurationBase(\n duration=polar_sdk.DiscountDuration.ONCE,\n type=polar_sdk.DiscountType.FIXED,\n amount=1000,\n currency=\"usd\",\n amounts={\n \"eur\": 900,\n \"usd\": 1000,\n },\n created_at=parse_datetime(\"2025-02-22T11:10:31.855Z\"),\n modified_at=parse_datetime(\"2025-10-07T09:47:56.854Z\"),\n id=\"\",\n metadata={\n\n },\n name=\"\",\n code=\"\",\n starts_at=parse_datetime(\"2026-10-30T07:18:57.755Z\"),\n ends_at=parse_datetime(\"2024-07-06T02:57:51.191Z\"),\n max_redemptions=200325,\n redemptions_count=66236,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n prices=[],\n meters=[\n polar_sdk.SubscriptionMeter(\n created_at=parse_datetime(\"2026-11-18T23:26:50.006Z\"),\n modified_at=parse_datetime(\"2025-05-31T09:53:13.946Z\"),\n id=\"\",\n consumed_units=25,\n credited_units=100,\n amount=0,\n meter_id=\"d498a884-e2cd-4d3e-8002-f536468a8b22\",\n meter=polar_sdk.Meter(\n metadata={\n\n },\n created_at=parse_datetime(\"2026-09-04T19:30:54.013Z\"),\n modified_at=parse_datetime(\"2026-12-28T16:59:30.195Z\"),\n id=\"\",\n name=\"\",\n filter_=polar_sdk.Filter(\n conjunction=polar_sdk.FilterConjunction.AND,\n clauses=[],\n ),\n aggregation=polar_sdk.PropertyAggregation(\n func=polar_sdk.Func.SUM,\n property=\"\",\n ),\n organization_id=\"\",\n ),\n ),\n ],\n pending_update=polar_sdk.PendingSubscriptionUpdate(\n created_at=parse_datetime(\"2025-10-14T14:30:17.100Z\"),\n modified_at=parse_datetime(\"2026-11-20T14:18:07.269Z\"),\n id=\"\",\n applies_at=parse_datetime(\"2025-05-25T04:21:31.587Z\"),\n product_id=\"\",\n seats=436642,\n ),\n ),\n ))\n\n # Handle response\n print(res)" diff --git a/docs/models/address.md b/docs/models/address.md index 4024d518..634729c2 100644 --- a/docs/models/address.md +++ b/docs/models/address.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -| `line1` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `line2` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `postal_code` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `state` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `country` | [models.CountryAlpha2](../models/countryalpha2.md) | :heavy_check_mark: | N/A | US | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | +| `line1` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `line2` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `postal_code` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `state` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `country` | [models.AddressCountryAlpha2](../models/addresscountryalpha2.md) | :heavy_check_mark: | N/A | US | \ No newline at end of file diff --git a/docs/models/addresscountryalpha2.md b/docs/models/addresscountryalpha2.md new file mode 100644 index 00000000..424eb6f5 --- /dev/null +++ b/docs/models/addresscountryalpha2.md @@ -0,0 +1,256 @@ +# AddressCountryAlpha2 + + +## Values + +| Name | Value | +| ----- | ----- | +| `AD` | AD | +| `AE` | AE | +| `AF` | AF | +| `AG` | AG | +| `AI` | AI | +| `AL` | AL | +| `AM` | AM | +| `AO` | AO | +| `AQ` | AQ | +| `AR` | AR | +| `AS` | AS | +| `AT` | AT | +| `AU` | AU | +| `AW` | AW | +| `AX` | AX | +| `AZ` | AZ | +| `BA` | BA | +| `BB` | BB | +| `BD` | BD | +| `BE` | BE | +| `BF` | BF | +| `BG` | BG | +| `BH` | BH | +| `BI` | BI | +| `BJ` | BJ | +| `BL` | BL | +| `BM` | BM | +| `BN` | BN | +| `BO` | BO | +| `BQ` | BQ | +| `BR` | BR | +| `BS` | BS | +| `BT` | BT | +| `BV` | BV | +| `BW` | BW | +| `BY` | BY | +| `BZ` | BZ | +| `CA` | CA | +| `CC` | CC | +| `CD` | CD | +| `CF` | CF | +| `CG` | CG | +| `CH` | CH | +| `CI` | CI | +| `CK` | CK | +| `CL` | CL | +| `CM` | CM | +| `CN` | CN | +| `CO` | CO | +| `CR` | CR | +| `CU` | CU | +| `CV` | CV | +| `CW` | CW | +| `CX` | CX | +| `CY` | CY | +| `CZ` | CZ | +| `DE` | DE | +| `DJ` | DJ | +| `DK` | DK | +| `DM` | DM | +| `DO` | DO | +| `DZ` | DZ | +| `EC` | EC | +| `EE` | EE | +| `EG` | EG | +| `EH` | EH | +| `ER` | ER | +| `ES` | ES | +| `ET` | ET | +| `FI` | FI | +| `FJ` | FJ | +| `FK` | FK | +| `FM` | FM | +| `FO` | FO | +| `FR` | FR | +| `GA` | GA | +| `GB` | GB | +| `GD` | GD | +| `GE` | GE | +| `GF` | GF | +| `GG` | GG | +| `GH` | GH | +| `GI` | GI | +| `GL` | GL | +| `GM` | GM | +| `GN` | GN | +| `GP` | GP | +| `GQ` | GQ | +| `GR` | GR | +| `GS` | GS | +| `GT` | GT | +| `GU` | GU | +| `GW` | GW | +| `GY` | GY | +| `HK` | HK | +| `HM` | HM | +| `HN` | HN | +| `HR` | HR | +| `HT` | HT | +| `HU` | HU | +| `ID` | ID | +| `IE` | IE | +| `IL` | IL | +| `IM` | IM | +| `IN` | IN | +| `IO` | IO | +| `IQ` | IQ | +| `IR` | IR | +| `IS` | IS | +| `IT` | IT | +| `JE` | JE | +| `JM` | JM | +| `JO` | JO | +| `JP` | JP | +| `KE` | KE | +| `KG` | KG | +| `KH` | KH | +| `KI` | KI | +| `KM` | KM | +| `KN` | KN | +| `KP` | KP | +| `KR` | KR | +| `KW` | KW | +| `KY` | KY | +| `KZ` | KZ | +| `LA` | LA | +| `LB` | LB | +| `LC` | LC | +| `LI` | LI | +| `LK` | LK | +| `LR` | LR | +| `LS` | LS | +| `LT` | LT | +| `LU` | LU | +| `LV` | LV | +| `LY` | LY | +| `MA` | MA | +| `MC` | MC | +| `MD` | MD | +| `ME` | ME | +| `MF` | MF | +| `MG` | MG | +| `MH` | MH | +| `MK` | MK | +| `ML` | ML | +| `MM` | MM | +| `MN` | MN | +| `MO` | MO | +| `MP` | MP | +| `MQ` | MQ | +| `MR` | MR | +| `MS` | MS | +| `MT` | MT | +| `MU` | MU | +| `MV` | MV | +| `MW` | MW | +| `MX` | MX | +| `MY` | MY | +| `MZ` | MZ | +| `NA` | NA | +| `NC` | NC | +| `NE` | NE | +| `NF` | NF | +| `NG` | NG | +| `NI` | NI | +| `NL` | NL | +| `NO` | NO | +| `NP` | NP | +| `NR` | NR | +| `NU` | NU | +| `NZ` | NZ | +| `OM` | OM | +| `PA` | PA | +| `PE` | PE | +| `PF` | PF | +| `PG` | PG | +| `PH` | PH | +| `PK` | PK | +| `PL` | PL | +| `PM` | PM | +| `PN` | PN | +| `PR` | PR | +| `PS` | PS | +| `PT` | PT | +| `PW` | PW | +| `PY` | PY | +| `QA` | QA | +| `RE` | RE | +| `RO` | RO | +| `RS` | RS | +| `RU` | RU | +| `RW` | RW | +| `SA` | SA | +| `SB` | SB | +| `SC` | SC | +| `SD` | SD | +| `SE` | SE | +| `SG` | SG | +| `SH` | SH | +| `SI` | SI | +| `SJ` | SJ | +| `SK` | SK | +| `SL` | SL | +| `SM` | SM | +| `SN` | SN | +| `SO` | SO | +| `SR` | SR | +| `SS` | SS | +| `ST` | ST | +| `SV` | SV | +| `SX` | SX | +| `SY` | SY | +| `SZ` | SZ | +| `TC` | TC | +| `TD` | TD | +| `TF` | TF | +| `TG` | TG | +| `TH` | TH | +| `TJ` | TJ | +| `TK` | TK | +| `TL` | TL | +| `TM` | TM | +| `TN` | TN | +| `TO` | TO | +| `TR` | TR | +| `TT` | TT | +| `TV` | TV | +| `TW` | TW | +| `TZ` | TZ | +| `UA` | UA | +| `UG` | UG | +| `UM` | UM | +| `US` | US | +| `UY` | UY | +| `UZ` | UZ | +| `VA` | VA | +| `VC` | VC | +| `VE` | VE | +| `VG` | VG | +| `VI` | VI | +| `VN` | VN | +| `VU` | VU | +| `WF` | WF | +| `WS` | WS | +| `YE` | YE | +| `YT` | YT | +| `ZA` | ZA | +| `ZM` | ZM | +| `ZW` | ZW | \ No newline at end of file diff --git a/docs/models/addressinput.md b/docs/models/addressinput.md index efeb0382..41512670 100644 --- a/docs/models/addressinput.md +++ b/docs/models/addressinput.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| `line1` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `line2` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `postal_code` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `state` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | -| `country` | [models.CountryAlpha2Input](../models/countryalpha2input.md) | :heavy_check_mark: | N/A | US | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `line1` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `line2` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `postal_code` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `city` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `state` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | +| `country` | [models.AddressInputCountryAlpha2Input](../models/addressinputcountryalpha2input.md) | :heavy_check_mark: | N/A | US | \ No newline at end of file diff --git a/docs/models/addressinputcountryalpha2input.md b/docs/models/addressinputcountryalpha2input.md new file mode 100644 index 00000000..a27e3d90 --- /dev/null +++ b/docs/models/addressinputcountryalpha2input.md @@ -0,0 +1,251 @@ +# AddressInputCountryAlpha2Input + + +## Values + +| Name | Value | +| ----- | ----- | +| `AD` | AD | +| `AE` | AE | +| `AF` | AF | +| `AG` | AG | +| `AI` | AI | +| `AL` | AL | +| `AM` | AM | +| `AO` | AO | +| `AQ` | AQ | +| `AR` | AR | +| `AS` | AS | +| `AT` | AT | +| `AU` | AU | +| `AW` | AW | +| `AX` | AX | +| `AZ` | AZ | +| `BA` | BA | +| `BB` | BB | +| `BD` | BD | +| `BE` | BE | +| `BF` | BF | +| `BG` | BG | +| `BH` | BH | +| `BI` | BI | +| `BJ` | BJ | +| `BL` | BL | +| `BM` | BM | +| `BN` | BN | +| `BO` | BO | +| `BQ` | BQ | +| `BR` | BR | +| `BS` | BS | +| `BT` | BT | +| `BV` | BV | +| `BW` | BW | +| `BY` | BY | +| `BZ` | BZ | +| `CA` | CA | +| `CC` | CC | +| `CD` | CD | +| `CF` | CF | +| `CG` | CG | +| `CH` | CH | +| `CI` | CI | +| `CK` | CK | +| `CL` | CL | +| `CM` | CM | +| `CN` | CN | +| `CO` | CO | +| `CR` | CR | +| `CV` | CV | +| `CW` | CW | +| `CX` | CX | +| `CY` | CY | +| `CZ` | CZ | +| `DE` | DE | +| `DJ` | DJ | +| `DK` | DK | +| `DM` | DM | +| `DO` | DO | +| `DZ` | DZ | +| `EC` | EC | +| `EE` | EE | +| `EG` | EG | +| `EH` | EH | +| `ER` | ER | +| `ES` | ES | +| `ET` | ET | +| `FI` | FI | +| `FJ` | FJ | +| `FK` | FK | +| `FM` | FM | +| `FO` | FO | +| `FR` | FR | +| `GA` | GA | +| `GB` | GB | +| `GD` | GD | +| `GE` | GE | +| `GF` | GF | +| `GG` | GG | +| `GH` | GH | +| `GI` | GI | +| `GL` | GL | +| `GM` | GM | +| `GN` | GN | +| `GP` | GP | +| `GQ` | GQ | +| `GR` | GR | +| `GS` | GS | +| `GT` | GT | +| `GU` | GU | +| `GW` | GW | +| `GY` | GY | +| `HK` | HK | +| `HM` | HM | +| `HN` | HN | +| `HR` | HR | +| `HT` | HT | +| `HU` | HU | +| `ID` | ID | +| `IE` | IE | +| `IL` | IL | +| `IM` | IM | +| `IN` | IN | +| `IO` | IO | +| `IQ` | IQ | +| `IS` | IS | +| `IT` | IT | +| `JE` | JE | +| `JM` | JM | +| `JO` | JO | +| `JP` | JP | +| `KE` | KE | +| `KG` | KG | +| `KH` | KH | +| `KI` | KI | +| `KM` | KM | +| `KN` | KN | +| `KR` | KR | +| `KW` | KW | +| `KY` | KY | +| `KZ` | KZ | +| `LA` | LA | +| `LB` | LB | +| `LC` | LC | +| `LI` | LI | +| `LK` | LK | +| `LR` | LR | +| `LS` | LS | +| `LT` | LT | +| `LU` | LU | +| `LV` | LV | +| `LY` | LY | +| `MA` | MA | +| `MC` | MC | +| `MD` | MD | +| `ME` | ME | +| `MF` | MF | +| `MG` | MG | +| `MH` | MH | +| `MK` | MK | +| `ML` | ML | +| `MM` | MM | +| `MN` | MN | +| `MO` | MO | +| `MP` | MP | +| `MQ` | MQ | +| `MR` | MR | +| `MS` | MS | +| `MT` | MT | +| `MU` | MU | +| `MV` | MV | +| `MW` | MW | +| `MX` | MX | +| `MY` | MY | +| `MZ` | MZ | +| `NA` | NA | +| `NC` | NC | +| `NE` | NE | +| `NF` | NF | +| `NG` | NG | +| `NI` | NI | +| `NL` | NL | +| `NO` | NO | +| `NP` | NP | +| `NR` | NR | +| `NU` | NU | +| `NZ` | NZ | +| `OM` | OM | +| `PA` | PA | +| `PE` | PE | +| `PF` | PF | +| `PG` | PG | +| `PH` | PH | +| `PK` | PK | +| `PL` | PL | +| `PM` | PM | +| `PN` | PN | +| `PR` | PR | +| `PS` | PS | +| `PT` | PT | +| `PW` | PW | +| `PY` | PY | +| `QA` | QA | +| `RE` | RE | +| `RO` | RO | +| `RS` | RS | +| `RW` | RW | +| `SA` | SA | +| `SB` | SB | +| `SC` | SC | +| `SD` | SD | +| `SE` | SE | +| `SG` | SG | +| `SH` | SH | +| `SI` | SI | +| `SJ` | SJ | +| `SK` | SK | +| `SL` | SL | +| `SM` | SM | +| `SN` | SN | +| `SO` | SO | +| `SR` | SR | +| `SS` | SS | +| `ST` | ST | +| `SV` | SV | +| `SX` | SX | +| `SZ` | SZ | +| `TC` | TC | +| `TD` | TD | +| `TF` | TF | +| `TG` | TG | +| `TH` | TH | +| `TJ` | TJ | +| `TK` | TK | +| `TL` | TL | +| `TM` | TM | +| `TN` | TN | +| `TO` | TO | +| `TR` | TR | +| `TT` | TT | +| `TV` | TV | +| `TW` | TW | +| `TZ` | TZ | +| `UA` | UA | +| `UG` | UG | +| `UM` | UM | +| `US` | US | +| `UY` | UY | +| `UZ` | UZ | +| `VA` | VA | +| `VC` | VC | +| `VE` | VE | +| `VG` | VG | +| `VI` | VI | +| `VN` | VN | +| `VU` | VU | +| `WF` | WF | +| `WS` | WS | +| `YE` | YE | +| `YT` | YT | +| `ZA` | ZA | +| `ZM` | ZM | +| `ZW` | ZW | \ No newline at end of file diff --git a/docs/models/checkout.md b/docs/models/checkout.md index 9fff9baa..91002db2 100644 --- a/docs/models/checkout.md +++ b/docs/models/checkout.md @@ -23,7 +23,6 @@ Checkout session data retrieved using an access token. | `seats` | *OptionalNullable[int]* | :heavy_minus_sign: | Predefined number of seats (works with seat-based pricing only) | | `min_seats` | *OptionalNullable[int]* | :heavy_minus_sign: | Minimum number of seats (works with seat-based pricing only) | | `max_seats` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum number of seats (works with seat-based pricing only) | -| `price_per_seat` | *OptionalNullable[int]* | :heavy_minus_sign: | Price per seat in cents for the current seat count, based on the applicable tier. Only relevant for seat-based pricing. | | `discount_amount` | *int* | :heavy_check_mark: | Discount amount in cents. | | `net_amount` | *int* | :heavy_check_mark: | Amount in cents, after discounts but before taxes. | | `tax_amount` | *Nullable[int]* | :heavy_check_mark: | Sales tax amount in cents. If `null`, it means there is no enough information yet to calculate it. | diff --git a/docs/models/checkoutpublic.md b/docs/models/checkoutpublic.md index 55a8348f..584966bf 100644 --- a/docs/models/checkoutpublic.md +++ b/docs/models/checkoutpublic.md @@ -23,7 +23,6 @@ Checkout session data retrieved using the client secret. | `seats` | *OptionalNullable[int]* | :heavy_minus_sign: | Predefined number of seats (works with seat-based pricing only) | | `min_seats` | *OptionalNullable[int]* | :heavy_minus_sign: | Minimum number of seats (works with seat-based pricing only) | | `max_seats` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum number of seats (works with seat-based pricing only) | -| `price_per_seat` | *OptionalNullable[int]* | :heavy_minus_sign: | Price per seat in cents for the current seat count, based on the applicable tier. Only relevant for seat-based pricing. | | `discount_amount` | *int* | :heavy_check_mark: | Discount amount in cents. | | `net_amount` | *int* | :heavy_check_mark: | Amount in cents, after discounts but before taxes. | | `tax_amount` | *Nullable[int]* | :heavy_check_mark: | Sales tax amount in cents. If `null`, it means there is no enough information yet to calculate it. | diff --git a/docs/models/checkoutpublicconfirmed.md b/docs/models/checkoutpublicconfirmed.md index a3ce96de..a1061b9b 100644 --- a/docs/models/checkoutpublicconfirmed.md +++ b/docs/models/checkoutpublicconfirmed.md @@ -26,7 +26,6 @@ right after the checkout. | `seats` | *OptionalNullable[int]* | :heavy_minus_sign: | Predefined number of seats (works with seat-based pricing only) | | `min_seats` | *OptionalNullable[int]* | :heavy_minus_sign: | Minimum number of seats (works with seat-based pricing only) | | `max_seats` | *OptionalNullable[int]* | :heavy_minus_sign: | Maximum number of seats (works with seat-based pricing only) | -| `price_per_seat` | *OptionalNullable[int]* | :heavy_minus_sign: | Price per seat in cents for the current seat count, based on the applicable tier. Only relevant for seat-based pricing. | | `discount_amount` | *int* | :heavy_check_mark: | Discount amount in cents. | | `net_amount` | *int* | :heavy_check_mark: | Amount in cents, after discounts but before taxes. | | `tax_amount` | *Nullable[int]* | :heavy_check_mark: | Sales tax amount in cents. If `null`, it means there is no enough information yet to calculate it. | diff --git a/docs/models/countrycountryalpha2input.md b/docs/models/countrycountryalpha2input.md new file mode 100644 index 00000000..e17c24d8 --- /dev/null +++ b/docs/models/countrycountryalpha2input.md @@ -0,0 +1,251 @@ +# CountryCountryAlpha2Input + + +## Values + +| Name | Value | +| ----- | ----- | +| `AD` | AD | +| `AE` | AE | +| `AF` | AF | +| `AG` | AG | +| `AI` | AI | +| `AL` | AL | +| `AM` | AM | +| `AO` | AO | +| `AQ` | AQ | +| `AR` | AR | +| `AS` | AS | +| `AT` | AT | +| `AU` | AU | +| `AW` | AW | +| `AX` | AX | +| `AZ` | AZ | +| `BA` | BA | +| `BB` | BB | +| `BD` | BD | +| `BE` | BE | +| `BF` | BF | +| `BG` | BG | +| `BH` | BH | +| `BI` | BI | +| `BJ` | BJ | +| `BL` | BL | +| `BM` | BM | +| `BN` | BN | +| `BO` | BO | +| `BQ` | BQ | +| `BR` | BR | +| `BS` | BS | +| `BT` | BT | +| `BV` | BV | +| `BW` | BW | +| `BY` | BY | +| `BZ` | BZ | +| `CA` | CA | +| `CC` | CC | +| `CD` | CD | +| `CF` | CF | +| `CG` | CG | +| `CH` | CH | +| `CI` | CI | +| `CK` | CK | +| `CL` | CL | +| `CM` | CM | +| `CN` | CN | +| `CO` | CO | +| `CR` | CR | +| `CV` | CV | +| `CW` | CW | +| `CX` | CX | +| `CY` | CY | +| `CZ` | CZ | +| `DE` | DE | +| `DJ` | DJ | +| `DK` | DK | +| `DM` | DM | +| `DO` | DO | +| `DZ` | DZ | +| `EC` | EC | +| `EE` | EE | +| `EG` | EG | +| `EH` | EH | +| `ER` | ER | +| `ES` | ES | +| `ET` | ET | +| `FI` | FI | +| `FJ` | FJ | +| `FK` | FK | +| `FM` | FM | +| `FO` | FO | +| `FR` | FR | +| `GA` | GA | +| `GB` | GB | +| `GD` | GD | +| `GE` | GE | +| `GF` | GF | +| `GG` | GG | +| `GH` | GH | +| `GI` | GI | +| `GL` | GL | +| `GM` | GM | +| `GN` | GN | +| `GP` | GP | +| `GQ` | GQ | +| `GR` | GR | +| `GS` | GS | +| `GT` | GT | +| `GU` | GU | +| `GW` | GW | +| `GY` | GY | +| `HK` | HK | +| `HM` | HM | +| `HN` | HN | +| `HR` | HR | +| `HT` | HT | +| `HU` | HU | +| `ID` | ID | +| `IE` | IE | +| `IL` | IL | +| `IM` | IM | +| `IN` | IN | +| `IO` | IO | +| `IQ` | IQ | +| `IS` | IS | +| `IT` | IT | +| `JE` | JE | +| `JM` | JM | +| `JO` | JO | +| `JP` | JP | +| `KE` | KE | +| `KG` | KG | +| `KH` | KH | +| `KI` | KI | +| `KM` | KM | +| `KN` | KN | +| `KR` | KR | +| `KW` | KW | +| `KY` | KY | +| `KZ` | KZ | +| `LA` | LA | +| `LB` | LB | +| `LC` | LC | +| `LI` | LI | +| `LK` | LK | +| `LR` | LR | +| `LS` | LS | +| `LT` | LT | +| `LU` | LU | +| `LV` | LV | +| `LY` | LY | +| `MA` | MA | +| `MC` | MC | +| `MD` | MD | +| `ME` | ME | +| `MF` | MF | +| `MG` | MG | +| `MH` | MH | +| `MK` | MK | +| `ML` | ML | +| `MM` | MM | +| `MN` | MN | +| `MO` | MO | +| `MP` | MP | +| `MQ` | MQ | +| `MR` | MR | +| `MS` | MS | +| `MT` | MT | +| `MU` | MU | +| `MV` | MV | +| `MW` | MW | +| `MX` | MX | +| `MY` | MY | +| `MZ` | MZ | +| `NA` | NA | +| `NC` | NC | +| `NE` | NE | +| `NF` | NF | +| `NG` | NG | +| `NI` | NI | +| `NL` | NL | +| `NO` | NO | +| `NP` | NP | +| `NR` | NR | +| `NU` | NU | +| `NZ` | NZ | +| `OM` | OM | +| `PA` | PA | +| `PE` | PE | +| `PF` | PF | +| `PG` | PG | +| `PH` | PH | +| `PK` | PK | +| `PL` | PL | +| `PM` | PM | +| `PN` | PN | +| `PR` | PR | +| `PS` | PS | +| `PT` | PT | +| `PW` | PW | +| `PY` | PY | +| `QA` | QA | +| `RE` | RE | +| `RO` | RO | +| `RS` | RS | +| `RW` | RW | +| `SA` | SA | +| `SB` | SB | +| `SC` | SC | +| `SD` | SD | +| `SE` | SE | +| `SG` | SG | +| `SH` | SH | +| `SI` | SI | +| `SJ` | SJ | +| `SK` | SK | +| `SL` | SL | +| `SM` | SM | +| `SN` | SN | +| `SO` | SO | +| `SR` | SR | +| `SS` | SS | +| `ST` | ST | +| `SV` | SV | +| `SX` | SX | +| `SZ` | SZ | +| `TC` | TC | +| `TD` | TD | +| `TF` | TF | +| `TG` | TG | +| `TH` | TH | +| `TJ` | TJ | +| `TK` | TK | +| `TL` | TL | +| `TM` | TM | +| `TN` | TN | +| `TO` | TO | +| `TR` | TR | +| `TT` | TT | +| `TV` | TV | +| `TW` | TW | +| `TZ` | TZ | +| `UA` | UA | +| `UG` | UG | +| `UM` | UM | +| `US` | US | +| `UY` | UY | +| `UZ` | UZ | +| `VA` | VA | +| `VC` | VC | +| `VE` | VE | +| `VG` | VG | +| `VI` | VI | +| `VN` | VN | +| `VU` | VU | +| `WF` | WF | +| `WS` | WS | +| `YE` | YE | +| `YT` | YT | +| `ZA` | ZA | +| `ZM` | ZM | +| `ZW` | ZW | \ No newline at end of file diff --git a/docs/models/customersubscription.md b/docs/models/customersubscription.md index 474dc165..6b79fdea 100644 --- a/docs/models/customersubscription.md +++ b/docs/models/customersubscription.md @@ -31,4 +31,5 @@ | `customer_cancellation_comment` | *Nullable[str]* | :heavy_check_mark: | N/A | | | `product` | [models.CustomerSubscriptionProduct](../models/customersubscriptionproduct.md) | :heavy_check_mark: | N/A | | | `prices` | List[[models.CustomerSubscriptionPrices](../models/customersubscriptionprices.md)] | :heavy_check_mark: | List of enabled prices for the subscription. | | -| `meters` | List[[models.CustomerSubscriptionMeter](../models/customersubscriptionmeter.md)] | :heavy_check_mark: | List of meters associated with the subscription. | | \ No newline at end of file +| `meters` | List[[models.CustomerSubscriptionMeter](../models/customersubscriptionmeter.md)] | :heavy_check_mark: | List of meters associated with the subscription. | | +| `pending_update` | [Nullable[models.PendingSubscriptionUpdate]](../models/pendingsubscriptionupdate.md) | :heavy_check_mark: | Pending subscription update that will be applied at the beginning of the next period. If `null`, there is no pending update. | | \ No newline at end of file diff --git a/docs/models/legacyrecurringproductpricecustom.md b/docs/models/legacyrecurringproductpricecustom.md index 2ce2f5df..2e0a6c29 100644 --- a/docs/models/legacyrecurringproductpricecustom.md +++ b/docs/models/legacyrecurringproductpricecustom.md @@ -15,6 +15,7 @@ A pay-what-you-want recurring price for a product, i.e. a subscription. | `source` | [models.ProductPriceSource](../models/productpricesource.md) | :heavy_check_mark: | N/A | | `amount_type` | *Literal["custom"]* | :heavy_check_mark: | N/A | | `price_currency` | *str* | :heavy_check_mark: | The currency in which the customer will be charged. | +| `tax_behavior` | [Nullable[models.TaxBehaviorOption]](../models/taxbehavioroption.md) | :heavy_check_mark: | The tax behavior of the price. If null, it defaults to the organization's default tax behavior. | | `is_archived` | *bool* | :heavy_check_mark: | Whether the price is archived and no longer available. | | `product_id` | *str* | :heavy_check_mark: | The ID of the product owning the price. | | `type` | *Literal["recurring"]* | :heavy_check_mark: | The type of the price. | diff --git a/docs/models/legacyrecurringproductpricefixed.md b/docs/models/legacyrecurringproductpricefixed.md index 7f7ca941..eb1f7353 100644 --- a/docs/models/legacyrecurringproductpricefixed.md +++ b/docs/models/legacyrecurringproductpricefixed.md @@ -7,17 +7,18 @@ A recurring price for a product, i.e. a subscription. ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Creation timestamp of the object. | -| `modified_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Last modification timestamp of the object. | -| `id` | *str* | :heavy_check_mark: | The ID of the price. | -| `source` | [models.ProductPriceSource](../models/productpricesource.md) | :heavy_check_mark: | N/A | -| `amount_type` | *Literal["fixed"]* | :heavy_check_mark: | N/A | -| `price_currency` | *str* | :heavy_check_mark: | The currency in which the customer will be charged. | -| `is_archived` | *bool* | :heavy_check_mark: | Whether the price is archived and no longer available. | -| `product_id` | *str* | :heavy_check_mark: | The ID of the product owning the price. | -| `type` | *Literal["recurring"]* | :heavy_check_mark: | The type of the price. | -| `recurring_interval` | [models.SubscriptionRecurringInterval](../models/subscriptionrecurringinterval.md) | :heavy_check_mark: | N/A | -| `price_amount` | *int* | :heavy_check_mark: | The price in cents. | -| `legacy` | *Literal[True]* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Creation timestamp of the object. | +| `modified_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Last modification timestamp of the object. | +| `id` | *str* | :heavy_check_mark: | The ID of the price. | +| `source` | [models.ProductPriceSource](../models/productpricesource.md) | :heavy_check_mark: | N/A | +| `amount_type` | *Literal["fixed"]* | :heavy_check_mark: | N/A | +| `price_currency` | *str* | :heavy_check_mark: | The currency in which the customer will be charged. | +| `tax_behavior` | [Nullable[models.TaxBehaviorOption]](../models/taxbehavioroption.md) | :heavy_check_mark: | The tax behavior of the price. If null, it defaults to the organization's default tax behavior. | +| `is_archived` | *bool* | :heavy_check_mark: | Whether the price is archived and no longer available. | +| `product_id` | *str* | :heavy_check_mark: | The ID of the product owning the price. | +| `type` | *Literal["recurring"]* | :heavy_check_mark: | The type of the price. | +| `recurring_interval` | [models.SubscriptionRecurringInterval](../models/subscriptionrecurringinterval.md) | :heavy_check_mark: | N/A | +| `price_amount` | *int* | :heavy_check_mark: | The price in cents. | +| `legacy` | *Literal[True]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/legacyrecurringproductpricefree.md b/docs/models/legacyrecurringproductpricefree.md index f0aa739d..6a9476f7 100644 --- a/docs/models/legacyrecurringproductpricefree.md +++ b/docs/models/legacyrecurringproductpricefree.md @@ -7,16 +7,17 @@ A free recurring price for a product, i.e. a subscription. ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Creation timestamp of the object. | -| `modified_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Last modification timestamp of the object. | -| `id` | *str* | :heavy_check_mark: | The ID of the price. | -| `source` | [models.ProductPriceSource](../models/productpricesource.md) | :heavy_check_mark: | N/A | -| `amount_type` | *Literal["free"]* | :heavy_check_mark: | N/A | -| `price_currency` | *str* | :heavy_check_mark: | The currency in which the customer will be charged. | -| `is_archived` | *bool* | :heavy_check_mark: | Whether the price is archived and no longer available. | -| `product_id` | *str* | :heavy_check_mark: | The ID of the product owning the price. | -| `type` | *Literal["recurring"]* | :heavy_check_mark: | The type of the price. | -| `recurring_interval` | [models.SubscriptionRecurringInterval](../models/subscriptionrecurringinterval.md) | :heavy_check_mark: | N/A | -| `legacy` | *Literal[True]* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Creation timestamp of the object. | +| `modified_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Last modification timestamp of the object. | +| `id` | *str* | :heavy_check_mark: | The ID of the price. | +| `source` | [models.ProductPriceSource](../models/productpricesource.md) | :heavy_check_mark: | N/A | +| `amount_type` | *Literal["free"]* | :heavy_check_mark: | N/A | +| `price_currency` | *str* | :heavy_check_mark: | The currency in which the customer will be charged. | +| `tax_behavior` | [Nullable[models.TaxBehaviorOption]](../models/taxbehavioroption.md) | :heavy_check_mark: | The tax behavior of the price. If null, it defaults to the organization's default tax behavior. | +| `is_archived` | *bool* | :heavy_check_mark: | Whether the price is archived and no longer available. | +| `product_id` | *str* | :heavy_check_mark: | The ID of the product owning the price. | +| `type` | *Literal["recurring"]* | :heavy_check_mark: | The type of the price. | +| `recurring_interval` | [models.SubscriptionRecurringInterval](../models/subscriptionrecurringinterval.md) | :heavy_check_mark: | N/A | +| `legacy` | *Literal[True]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/legalentity.md b/docs/models/legalentity.md new file mode 100644 index 00000000..413781e3 --- /dev/null +++ b/docs/models/legalentity.md @@ -0,0 +1,17 @@ +# LegalEntity + + +## Supported Types + +### `models.OrganizationCompanyLegalEntitySchema` + +```python +value: models.OrganizationCompanyLegalEntitySchema = /* values here */ +``` + +### `models.OrganizationIndividualLegalEntitySchema` + +```python +value: models.OrganizationIndividualLegalEntitySchema = /* values here */ +``` + diff --git a/docs/models/memberslistmembersrequest.md b/docs/models/memberslistmembersrequest.md index 1d861642..adaecd54 100644 --- a/docs/models/memberslistmembersrequest.md +++ b/docs/models/memberslistmembersrequest.md @@ -7,6 +7,7 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `customer_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Filter by customer ID. | | `external_customer_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Filter by customer external ID. | +| `role` | [OptionalNullable[models.MemberRole]](../models/memberrole.md) | :heavy_minus_sign: | Filter by member role. | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number, defaults to 1. | | `limit` | *Optional[int]* | :heavy_minus_sign: | Size of a page, defaults to 10. Maximum is 100. | | `sorting` | List[[models.MemberSortProperty](../models/membersortproperty.md)] | :heavy_minus_sign: | Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order. | \ No newline at end of file diff --git a/docs/models/metricperiod.md b/docs/models/metricperiod.md index b283e0d0..f9dc4a9f 100644 --- a/docs/models/metricperiod.md +++ b/docs/models/metricperiod.md @@ -14,6 +14,7 @@ | `checkouts` | [OptionalNullable[models.CheckoutsModel]](../models/checkoutsmodel.md) | :heavy_minus_sign: | N/A | | `succeeded_checkouts` | [OptionalNullable[models.SucceededCheckouts]](../models/succeededcheckouts.md) | :heavy_minus_sign: | N/A | | `churned_subscriptions` | [OptionalNullable[models.ChurnedSubscriptions]](../models/churnedsubscriptions.md) | :heavy_minus_sign: | N/A | +| `churn_rate` | [OptionalNullable[models.ChurnRate]](../models/churnrate.md) | :heavy_minus_sign: | N/A | | `orders` | [OptionalNullable[models.OrdersModel]](../models/ordersmodel.md) | :heavy_minus_sign: | N/A | | `revenue` | [OptionalNullable[models.Revenue]](../models/revenue.md) | :heavy_minus_sign: | N/A | | `net_revenue` | [OptionalNullable[models.NetRevenue]](../models/netrevenue.md) | :heavy_minus_sign: | N/A | @@ -44,7 +45,6 @@ | `canceled_subscriptions_unused` | [OptionalNullable[models.CanceledSubscriptionsUnused]](../models/canceledsubscriptionsunused.md) | :heavy_minus_sign: | N/A | | `canceled_subscriptions_other` | [OptionalNullable[models.CanceledSubscriptionsOther]](../models/canceledsubscriptionsother.md) | :heavy_minus_sign: | N/A | | `checkouts_conversion` | [OptionalNullable[models.CheckoutsConversion]](../models/checkoutsconversion.md) | :heavy_minus_sign: | N/A | -| `churn_rate` | [OptionalNullable[models.ChurnRate]](../models/churnrate.md) | :heavy_minus_sign: | N/A | | `ltv` | [OptionalNullable[models.Ltv]](../models/ltv.md) | :heavy_minus_sign: | N/A | | `gross_margin` | [OptionalNullable[models.GrossMargin]](../models/grossmargin.md) | :heavy_minus_sign: | N/A | | `gross_margin_percentage` | [OptionalNullable[models.GrossMarginPercentage]](../models/grossmarginpercentage.md) | :heavy_minus_sign: | N/A | diff --git a/docs/models/metrics.md b/docs/models/metrics.md index 275d51aa..1c331a4c 100644 --- a/docs/models/metrics.md +++ b/docs/models/metrics.md @@ -13,6 +13,7 @@ | `checkouts` | [OptionalNullable[models.Metric]](../models/metric.md) | :heavy_minus_sign: | N/A | | `succeeded_checkouts` | [OptionalNullable[models.Metric]](../models/metric.md) | :heavy_minus_sign: | N/A | | `churned_subscriptions` | [OptionalNullable[models.Metric]](../models/metric.md) | :heavy_minus_sign: | N/A | +| `churn_rate` | [OptionalNullable[models.Metric]](../models/metric.md) | :heavy_minus_sign: | N/A | | `orders` | [OptionalNullable[models.Metric]](../models/metric.md) | :heavy_minus_sign: | N/A | | `revenue` | [OptionalNullable[models.Metric]](../models/metric.md) | :heavy_minus_sign: | N/A | | `net_revenue` | [OptionalNullable[models.Metric]](../models/metric.md) | :heavy_minus_sign: | N/A | @@ -43,7 +44,6 @@ | `canceled_subscriptions_unused` | [OptionalNullable[models.Metric]](../models/metric.md) | :heavy_minus_sign: | N/A | | `canceled_subscriptions_other` | [OptionalNullable[models.Metric]](../models/metric.md) | :heavy_minus_sign: | N/A | | `checkouts_conversion` | [OptionalNullable[models.Metric]](../models/metric.md) | :heavy_minus_sign: | N/A | -| `churn_rate` | [OptionalNullable[models.Metric]](../models/metric.md) | :heavy_minus_sign: | N/A | | `ltv` | [OptionalNullable[models.Metric]](../models/metric.md) | :heavy_minus_sign: | N/A | | `gross_margin` | [OptionalNullable[models.Metric]](../models/metric.md) | :heavy_minus_sign: | N/A | | `gross_margin_percentage` | [OptionalNullable[models.Metric]](../models/metric.md) | :heavy_minus_sign: | N/A | diff --git a/docs/models/metricstotals.md b/docs/models/metricstotals.md index 0fe422f1..0324cc49 100644 --- a/docs/models/metricstotals.md +++ b/docs/models/metricstotals.md @@ -13,6 +13,7 @@ | `checkouts` | [OptionalNullable[models.MetricsTotalsCheckouts]](../models/metricstotalscheckouts.md) | :heavy_minus_sign: | N/A | | `succeeded_checkouts` | [OptionalNullable[models.MetricsTotalsSucceededCheckouts]](../models/metricstotalssucceededcheckouts.md) | :heavy_minus_sign: | N/A | | `churned_subscriptions` | [OptionalNullable[models.MetricsTotalsChurnedSubscriptions]](../models/metricstotalschurnedsubscriptions.md) | :heavy_minus_sign: | N/A | +| `churn_rate` | [OptionalNullable[models.MetricsTotalsChurnRate]](../models/metricstotalschurnrate.md) | :heavy_minus_sign: | N/A | | `orders` | [OptionalNullable[models.MetricsTotalsOrders]](../models/metricstotalsorders.md) | :heavy_minus_sign: | N/A | | `revenue` | [OptionalNullable[models.MetricsTotalsRevenue]](../models/metricstotalsrevenue.md) | :heavy_minus_sign: | N/A | | `net_revenue` | [OptionalNullable[models.MetricsTotalsNetRevenue]](../models/metricstotalsnetrevenue.md) | :heavy_minus_sign: | N/A | @@ -43,7 +44,6 @@ | `canceled_subscriptions_unused` | [OptionalNullable[models.MetricsTotalsCanceledSubscriptionsUnused]](../models/metricstotalscanceledsubscriptionsunused.md) | :heavy_minus_sign: | N/A | | `canceled_subscriptions_other` | [OptionalNullable[models.MetricsTotalsCanceledSubscriptionsOther]](../models/metricstotalscanceledsubscriptionsother.md) | :heavy_minus_sign: | N/A | | `checkouts_conversion` | [OptionalNullable[models.MetricsTotalsCheckoutsConversion]](../models/metricstotalscheckoutsconversion.md) | :heavy_minus_sign: | N/A | -| `churn_rate` | [OptionalNullable[models.MetricsTotalsChurnRate]](../models/metricstotalschurnrate.md) | :heavy_minus_sign: | N/A | | `ltv` | [OptionalNullable[models.MetricsTotalsLtv]](../models/metricstotalsltv.md) | :heavy_minus_sign: | N/A | | `gross_margin` | [OptionalNullable[models.MetricsTotalsGrossMargin]](../models/metricstotalsgrossmargin.md) | :heavy_minus_sign: | N/A | | `gross_margin_percentage` | [OptionalNullable[models.MetricsTotalsGrossMarginPercentage]](../models/metricstotalsgrossmarginpercentage.md) | :heavy_minus_sign: | N/A | diff --git a/docs/models/organization.md b/docs/models/organization.md index 61fc4add..4df75a6b 100644 --- a/docs/models/organization.md +++ b/docs/models/organization.md @@ -17,10 +17,12 @@ | `website` | *Nullable[str]* | :heavy_check_mark: | Official website of the organization. | | `socials` | List[[models.OrganizationSocialLink](../models/organizationsociallink.md)] | :heavy_check_mark: | Links to social profiles. | | `status` | [models.OrganizationStatus](../models/organizationstatus.md) | :heavy_check_mark: | N/A | -| `details_submitted_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | When the business details were submitted. | +| `details_submitted_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | When the business details were submitted for review. | | `default_presentment_currency` | *str* | :heavy_check_mark: | Default presentment currency. Used as fallback in checkout and customer portal, if the customer's local currency is not available. | +| `default_tax_behavior` | [models.TaxBehaviorOption](../models/taxbehavioroption.md) | :heavy_check_mark: | N/A | | `feature_settings` | [Nullable[models.OrganizationFeatureSettings]](../models/organizationfeaturesettings.md) | :heavy_check_mark: | Organization feature settings | | `subscription_settings` | [models.OrganizationSubscriptionSettings](../models/organizationsubscriptionsettings.md) | :heavy_check_mark: | N/A | | `notification_settings` | [models.OrganizationNotificationSettings](../models/organizationnotificationsettings.md) | :heavy_check_mark: | N/A | | `customer_email_settings` | [models.OrganizationCustomerEmailSettings](../models/organizationcustomeremailsettings.md) | :heavy_check_mark: | N/A | -| `customer_portal_settings` | [models.OrganizationCustomerPortalSettings](../models/organizationcustomerportalsettings.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `customer_portal_settings` | [models.OrganizationCustomerPortalSettings](../models/organizationcustomerportalsettings.md) | :heavy_check_mark: | N/A | +| `country` | [OptionalNullable[models.CountryAlpha2]](../models/countryalpha2.md) | :heavy_minus_sign: | Two-letter country code (ISO 3166-1 alpha-2). | \ No newline at end of file diff --git a/docs/models/organizationcompanylegalentityschema.md b/docs/models/organizationcompanylegalentityschema.md new file mode 100644 index 00000000..3e1eefcd --- /dev/null +++ b/docs/models/organizationcompanylegalentityschema.md @@ -0,0 +1,9 @@ +# OrganizationCompanyLegalEntitySchema + + +## Fields + +| Field | Type | Required | Description | +| -------------------- | -------------------- | -------------------- | -------------------- | +| `type` | *Literal["company"]* | :heavy_check_mark: | N/A | +| `registered_name` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/organizationcreate.md b/docs/models/organizationcreate.md index 82b7cd51..4b3f046b 100644 --- a/docs/models/organizationcreate.md +++ b/docs/models/organizationcreate.md @@ -8,13 +8,16 @@ | `name` | *str* | :heavy_check_mark: | N/A | | `slug` | *str* | :heavy_check_mark: | N/A | | `avatar_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `legal_entity` | [OptionalNullable[models.LegalEntity]](../models/legalentity.md) | :heavy_minus_sign: | N/A | | `email` | *OptionalNullable[str]* | :heavy_minus_sign: | Public support email. | | `website` | *OptionalNullable[str]* | :heavy_minus_sign: | Official website of the organization. | | `socials` | List[[models.OrganizationSocialLink](../models/organizationsociallink.md)] | :heavy_minus_sign: | Link to social profiles. | | `details` | [OptionalNullable[models.OrganizationDetails]](../models/organizationdetails.md) | :heavy_minus_sign: | Additional, private, business details Polar needs about active organizations for compliance (KYC). | +| `country` | [OptionalNullable[models.CountryAlpha2Input]](../models/countryalpha2input.md) | :heavy_minus_sign: | Two-letter country code (ISO 3166-1 alpha-2). | | `feature_settings` | [OptionalNullable[models.OrganizationFeatureSettings]](../models/organizationfeaturesettings.md) | :heavy_minus_sign: | N/A | | `subscription_settings` | [OptionalNullable[models.OrganizationSubscriptionSettings]](../models/organizationsubscriptionsettings.md) | :heavy_minus_sign: | N/A | | `notification_settings` | [OptionalNullable[models.OrganizationNotificationSettings]](../models/organizationnotificationsettings.md) | :heavy_minus_sign: | N/A | | `customer_email_settings` | [OptionalNullable[models.OrganizationCustomerEmailSettings]](../models/organizationcustomeremailsettings.md) | :heavy_minus_sign: | N/A | | `customer_portal_settings` | [OptionalNullable[models.OrganizationCustomerPortalSettings]](../models/organizationcustomerportalsettings.md) | :heavy_minus_sign: | N/A | -| `default_presentment_currency` | [Optional[models.PresentmentCurrency]](../models/presentmentcurrency.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| `default_presentment_currency` | [Optional[models.PresentmentCurrency]](../models/presentmentcurrency.md) | :heavy_minus_sign: | N/A | +| `default_tax_behavior` | [Optional[models.TaxBehaviorOption]](../models/taxbehavioroption.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/organizationcustomeremailsettings.md b/docs/models/organizationcustomeremailsettings.md index c0f0c5b9..32d6aa8e 100644 --- a/docs/models/organizationcustomeremailsettings.md +++ b/docs/models/organizationcustomeremailsettings.md @@ -3,14 +3,16 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------- | --------------------------------- | --------------------------------- | --------------------------------- | -| `order_confirmation` | *bool* | :heavy_check_mark: | N/A | -| `subscription_cancellation` | *bool* | :heavy_check_mark: | N/A | -| `subscription_confirmation` | *bool* | :heavy_check_mark: | N/A | -| `subscription_cycled` | *bool* | :heavy_check_mark: | N/A | -| `subscription_cycled_after_trial` | *bool* | :heavy_check_mark: | N/A | -| `subscription_past_due` | *bool* | :heavy_check_mark: | N/A | -| `subscription_revoked` | *bool* | :heavy_check_mark: | N/A | -| `subscription_uncanceled` | *bool* | :heavy_check_mark: | N/A | -| `subscription_updated` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| `order_confirmation` | *bool* | :heavy_check_mark: | N/A | +| `subscription_cancellation` | *bool* | :heavy_check_mark: | N/A | +| `subscription_confirmation` | *bool* | :heavy_check_mark: | N/A | +| `subscription_cycled` | *bool* | :heavy_check_mark: | N/A | +| `subscription_cycled_after_trial` | *bool* | :heavy_check_mark: | N/A | +| `subscription_past_due` | *bool* | :heavy_check_mark: | N/A | +| `subscription_renewal_reminder` | *bool* | :heavy_check_mark: | N/A | +| `subscription_revoked` | *bool* | :heavy_check_mark: | N/A | +| `subscription_trial_conversion_reminder` | *bool* | :heavy_check_mark: | N/A | +| `subscription_uncanceled` | *bool* | :heavy_check_mark: | N/A | +| `subscription_updated` | *bool* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/organizationdetails.md b/docs/models/organizationdetails.md index 959b3953..c96b45c9 100644 --- a/docs/models/organizationdetails.md +++ b/docs/models/organizationdetails.md @@ -3,13 +3,15 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `about` | *str* | :heavy_check_mark: | Brief information about you and your business. | -| `product_description` | *str* | :heavy_check_mark: | Description of digital products being sold. | -| `intended_use` | *str* | :heavy_check_mark: | How the organization will integrate and use Polar. | -| `customer_acquisition` | List[*str*] | :heavy_check_mark: | Main customer acquisition channels. | -| `future_annual_revenue` | *int* | :heavy_check_mark: | Estimated revenue in the next 12 months | -| `switching` | *Optional[bool]* | :heavy_minus_sign: | Switching from another platform? | -| `switching_from` | [OptionalNullable[models.SwitchingFrom]](../models/switchingfrom.md) | :heavy_minus_sign: | Which platform the organization is migrating from. | -| `previous_annual_revenue` | *Optional[int]* | :heavy_minus_sign: | Revenue from last year if applicable. | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ~~`about`~~ | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Brief information about you and your business. | +| `product_description` | *OptionalNullable[str]* | :heavy_minus_sign: | Description of digital products being sold. | +| `selling_categories` | List[*str*] | :heavy_minus_sign: | Categories of products being sold. | +| `pricing_models` | List[*str*] | :heavy_minus_sign: | Pricing models used by the organization. | +| ~~`intended_use`~~ | *OptionalNullable[str]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

How the organization will integrate and use Polar. | +| ~~`customer_acquisition`~~ | List[*str*] | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Main customer acquisition channels. | +| ~~`future_annual_revenue`~~ | *OptionalNullable[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Estimated revenue in the next 12 months | +| `switching` | *Optional[bool]* | :heavy_minus_sign: | Switching from another platform? | +| `switching_from` | [OptionalNullable[models.SwitchingFrom]](../models/switchingfrom.md) | :heavy_minus_sign: | Which platform the organization is migrating from. | +| ~~`previous_annual_revenue`~~ | *OptionalNullable[int]* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Revenue from last year if applicable. | \ No newline at end of file diff --git a/docs/models/organizationindividuallegalentityschema.md b/docs/models/organizationindividuallegalentityschema.md new file mode 100644 index 00000000..d3e78ade --- /dev/null +++ b/docs/models/organizationindividuallegalentityschema.md @@ -0,0 +1,8 @@ +# OrganizationIndividualLegalEntitySchema + + +## Fields + +| Field | Type | Required | Description | +| ----------------------- | ----------------------- | ----------------------- | ----------------------- | +| `type` | *Literal["individual"]* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/organizationupdate.md b/docs/models/organizationupdate.md index 13881861..aaf4afe3 100644 --- a/docs/models/organizationupdate.md +++ b/docs/models/organizationupdate.md @@ -11,9 +11,11 @@ | `website` | *OptionalNullable[str]* | :heavy_minus_sign: | Official website of the organization. | | `socials` | List[[models.OrganizationSocialLink](../models/organizationsociallink.md)] | :heavy_minus_sign: | Links to social profiles. | | `details` | [OptionalNullable[models.OrganizationDetails]](../models/organizationdetails.md) | :heavy_minus_sign: | Additional, private, business details Polar needs about active organizations for compliance (KYC). | +| `country` | [OptionalNullable[models.CountryCountryAlpha2Input]](../models/countrycountryalpha2input.md) | :heavy_minus_sign: | Two-letter country code (ISO 3166-1 alpha-2). | | `feature_settings` | [OptionalNullable[models.OrganizationFeatureSettings]](../models/organizationfeaturesettings.md) | :heavy_minus_sign: | N/A | | `subscription_settings` | [OptionalNullable[models.OrganizationSubscriptionSettings]](../models/organizationsubscriptionsettings.md) | :heavy_minus_sign: | N/A | | `notification_settings` | [OptionalNullable[models.OrganizationNotificationSettings]](../models/organizationnotificationsettings.md) | :heavy_minus_sign: | N/A | | `customer_email_settings` | [OptionalNullable[models.OrganizationCustomerEmailSettings]](../models/organizationcustomeremailsettings.md) | :heavy_minus_sign: | N/A | | `customer_portal_settings` | [OptionalNullable[models.OrganizationCustomerPortalSettings]](../models/organizationcustomerportalsettings.md) | :heavy_minus_sign: | N/A | -| `default_presentment_currency` | [OptionalNullable[models.PresentmentCurrency]](../models/presentmentcurrency.md) | :heavy_minus_sign: | Default presentment currency for the organization | \ No newline at end of file +| `default_presentment_currency` | [OptionalNullable[models.PresentmentCurrency]](../models/presentmentcurrency.md) | :heavy_minus_sign: | Default presentment currency for the organization | +| `default_tax_behavior` | [OptionalNullable[models.TaxBehaviorOption]](../models/taxbehavioroption.md) | :heavy_minus_sign: | Default tax behavior applied on products. | \ No newline at end of file diff --git a/docs/models/paymentfailed.md b/docs/models/paymentfailed.md new file mode 100644 index 00000000..ff0a9db3 --- /dev/null +++ b/docs/models/paymentfailed.md @@ -0,0 +1,9 @@ +# PaymentFailed + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------- | -------------------------- | -------------------------- | -------------------------- | -------------------------- | +| `error` | *Literal["PaymentFailed"]* | :heavy_check_mark: | N/A | PaymentFailed | +| `detail` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/pendingsubscriptionupdate.md b/docs/models/pendingsubscriptionupdate.md new file mode 100644 index 00000000..0661dbf1 --- /dev/null +++ b/docs/models/pendingsubscriptionupdate.md @@ -0,0 +1,15 @@ +# PendingSubscriptionUpdate + +Pending update to be applied to a subscription at the beginning of the next period. + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Creation timestamp of the object. | +| `modified_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Last modification timestamp of the object. | +| `id` | *str* | :heavy_check_mark: | The ID of the object. | +| `applies_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date and time when the subscription update will be applied. | +| `product_id` | *Nullable[str]* | :heavy_check_mark: | ID of the new product to apply to the subscription. If `null`, the product won't be changed. | +| `seats` | *Nullable[int]* | :heavy_check_mark: | Number of seats to apply to the subscription. If `null`, the number of seats won't be changed. | \ No newline at end of file diff --git a/docs/models/presentmentcurrency.md b/docs/models/presentmentcurrency.md index e8dedae8..00006ffa 100644 --- a/docs/models/presentmentcurrency.md +++ b/docs/models/presentmentcurrency.md @@ -5,13 +5,39 @@ | Name | Value | | ----- | ----- | +| `AED` | aed | +| `ARS` | ars | | `AUD` | aud | | `BRL` | brl | | `CAD` | cad | | `CHF` | chf | +| `CLP` | clp | +| `CNY` | cny | +| `COP` | cop | +| `CZK` | czk | +| `DKK` | dkk | | `EUR` | eur | -| `INR` | inr | | `GBP` | gbp | +| `HKD` | hkd | +| `HUF` | huf | +| `IDR` | idr | +| `ILS` | ils | +| `INR` | inr | | `JPY` | jpy | +| `KRW` | krw | +| `MXN` | mxn | +| `MYR` | myr | +| `NOK` | nok | +| `NZD` | nzd | +| `PEN` | pen | +| `PHP` | php | +| `PLN` | pln | +| `RON` | ron | +| `SAR` | sar | | `SEK` | sek | -| `USD` | usd | \ No newline at end of file +| `SGD` | sgd | +| `THB` | thb | +| `TRY` | try | +| `TWD` | twd | +| `USD` | usd | +| `ZAR` | zar | \ No newline at end of file diff --git a/docs/models/productpricecustom.md b/docs/models/productpricecustom.md index 0063b1ea..900fa210 100644 --- a/docs/models/productpricecustom.md +++ b/docs/models/productpricecustom.md @@ -13,6 +13,7 @@ A pay-what-you-want price for a product. | `source` | [models.ProductPriceSource](../models/productpricesource.md) | :heavy_check_mark: | N/A | | `amount_type` | *Literal["custom"]* | :heavy_check_mark: | N/A | | `price_currency` | *str* | :heavy_check_mark: | The currency in which the customer will be charged. | +| `tax_behavior` | [Nullable[models.TaxBehaviorOption]](../models/taxbehavioroption.md) | :heavy_check_mark: | The tax behavior of the price. If null, it defaults to the organization's default tax behavior. | | `is_archived` | *bool* | :heavy_check_mark: | Whether the price is archived and no longer available. | | `product_id` | *str* | :heavy_check_mark: | The ID of the product owning the price. | | `minimum_amount` | *int* | :heavy_check_mark: | The minimum amount the customer can pay. If 0, the price is 'free or pay what you want'. Defaults to 50 cents. | diff --git a/docs/models/productpricecustomcreate.md b/docs/models/productpricecustomcreate.md index d72646dd..b1a8bde0 100644 --- a/docs/models/productpricecustomcreate.md +++ b/docs/models/productpricecustomcreate.md @@ -9,6 +9,7 @@ Schema to create a pay-what-you-want price. | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `amount_type` | *Literal["custom"]* | :heavy_check_mark: | N/A | | `price_currency` | [Optional[models.PresentmentCurrency]](../models/presentmentcurrency.md) | :heavy_minus_sign: | N/A | +| `tax_behavior` | [OptionalNullable[models.TaxBehaviorOption]](../models/taxbehavioroption.md) | :heavy_minus_sign: | The tax behavior of the price. If not set, it will default to the organization's default tax behavior. | | `minimum_amount` | *Optional[int]* | :heavy_minus_sign: | The minimum amount the customer can pay. If set to 0, the price is 'free or pay what you want' and $0 is accepted. If set to a value between 1-49, it will be rejected. Defaults to 50 cents. | | `maximum_amount` | *OptionalNullable[int]* | :heavy_minus_sign: | The maximum amount the customer can pay. | | `preset_amount` | *OptionalNullable[int]* | :heavy_minus_sign: | The initial amount shown to the customer. If 0, the customer will see $0 as the default. Values between 1-49 are rejected. | \ No newline at end of file diff --git a/docs/models/productpricefixed.md b/docs/models/productpricefixed.md index 266d541e..b52d5f57 100644 --- a/docs/models/productpricefixed.md +++ b/docs/models/productpricefixed.md @@ -5,14 +5,15 @@ A fixed price for a product. ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Creation timestamp of the object. | -| `modified_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Last modification timestamp of the object. | -| `id` | *str* | :heavy_check_mark: | The ID of the price. | -| `source` | [models.ProductPriceSource](../models/productpricesource.md) | :heavy_check_mark: | N/A | -| `amount_type` | *Literal["fixed"]* | :heavy_check_mark: | N/A | -| `price_currency` | *str* | :heavy_check_mark: | The currency in which the customer will be charged. | -| `is_archived` | *bool* | :heavy_check_mark: | Whether the price is archived and no longer available. | -| `product_id` | *str* | :heavy_check_mark: | The ID of the product owning the price. | -| `price_amount` | *int* | :heavy_check_mark: | The price in cents. | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Creation timestamp of the object. | +| `modified_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Last modification timestamp of the object. | +| `id` | *str* | :heavy_check_mark: | The ID of the price. | +| `source` | [models.ProductPriceSource](../models/productpricesource.md) | :heavy_check_mark: | N/A | +| `amount_type` | *Literal["fixed"]* | :heavy_check_mark: | N/A | +| `price_currency` | *str* | :heavy_check_mark: | The currency in which the customer will be charged. | +| `tax_behavior` | [Nullable[models.TaxBehaviorOption]](../models/taxbehavioroption.md) | :heavy_check_mark: | The tax behavior of the price. If null, it defaults to the organization's default tax behavior. | +| `is_archived` | *bool* | :heavy_check_mark: | Whether the price is archived and no longer available. | +| `product_id` | *str* | :heavy_check_mark: | The ID of the product owning the price. | +| `price_amount` | *int* | :heavy_check_mark: | The price in cents. | \ No newline at end of file diff --git a/docs/models/productpricefixedcreate.md b/docs/models/productpricefixedcreate.md index 85a04541..4f76ed9b 100644 --- a/docs/models/productpricefixedcreate.md +++ b/docs/models/productpricefixedcreate.md @@ -5,8 +5,9 @@ Schema to create a fixed price. ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `amount_type` | *Literal["fixed"]* | :heavy_check_mark: | N/A | -| `price_currency` | [Optional[models.PresentmentCurrency]](../models/presentmentcurrency.md) | :heavy_minus_sign: | N/A | -| `price_amount` | *int* | :heavy_check_mark: | The price in cents. | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `amount_type` | *Literal["fixed"]* | :heavy_check_mark: | N/A | +| `price_currency` | [Optional[models.PresentmentCurrency]](../models/presentmentcurrency.md) | :heavy_minus_sign: | N/A | +| `tax_behavior` | [OptionalNullable[models.TaxBehaviorOption]](../models/taxbehavioroption.md) | :heavy_minus_sign: | The tax behavior of the price. If not set, it will default to the organization's default tax behavior. | +| `price_amount` | *int* | :heavy_check_mark: | The price in cents.
Minimum amounts per currency:
- USD: $0.50
- AED: AED2.00
- ARS: ARS0.50
- AUD: A$0.50
- BRL: R$0.50
- CAD: CA$0.50
- CHF: CHF0.50
- COP: COP0.50
- CZK: CZK15.00
- DKK: DKK2.50
- EUR: €0.50
- GBP: £0.30
- HKD: HK$4.00
- HUF: HUF175.00
- IDR: IDR0.50
- ILS: ₪0.50
- INR: ₹60.00
- JPY: ¥50
- KRW: ₩50
- MXN: MX$0.10
- MYR: MYR2.00
- NOK: NOK3.00
- NZD: NZ$0.50
- PHP: ₱0.50
- PLN: PLN2.00
- RON: RON2.00
- RUB: RUB0.50
- SEK: SEK3.00
- SGD: SGD0.50
- THB: THB0.10
- ZAR: ZAR0.50 | \ No newline at end of file diff --git a/docs/models/productpricefree.md b/docs/models/productpricefree.md index aef1b7ce..4cbb0aa9 100644 --- a/docs/models/productpricefree.md +++ b/docs/models/productpricefree.md @@ -5,13 +5,14 @@ A free price for a product. ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Creation timestamp of the object. | -| `modified_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Last modification timestamp of the object. | -| `id` | *str* | :heavy_check_mark: | The ID of the price. | -| `source` | [models.ProductPriceSource](../models/productpricesource.md) | :heavy_check_mark: | N/A | -| `amount_type` | *Literal["free"]* | :heavy_check_mark: | N/A | -| `price_currency` | *str* | :heavy_check_mark: | The currency in which the customer will be charged. | -| `is_archived` | *bool* | :heavy_check_mark: | Whether the price is archived and no longer available. | -| `product_id` | *str* | :heavy_check_mark: | The ID of the product owning the price. | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Creation timestamp of the object. | +| `modified_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Last modification timestamp of the object. | +| `id` | *str* | :heavy_check_mark: | The ID of the price. | +| `source` | [models.ProductPriceSource](../models/productpricesource.md) | :heavy_check_mark: | N/A | +| `amount_type` | *Literal["free"]* | :heavy_check_mark: | N/A | +| `price_currency` | *str* | :heavy_check_mark: | The currency in which the customer will be charged. | +| `tax_behavior` | [Nullable[models.TaxBehaviorOption]](../models/taxbehavioroption.md) | :heavy_check_mark: | The tax behavior of the price. If null, it defaults to the organization's default tax behavior. | +| `is_archived` | *bool* | :heavy_check_mark: | Whether the price is archived and no longer available. | +| `product_id` | *str* | :heavy_check_mark: | The ID of the product owning the price. | \ No newline at end of file diff --git a/docs/models/productpricefreecreate.md b/docs/models/productpricefreecreate.md index a34c17eb..ef7ec575 100644 --- a/docs/models/productpricefreecreate.md +++ b/docs/models/productpricefreecreate.md @@ -5,7 +5,8 @@ Schema to create a free price. ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `amount_type` | *Literal["free"]* | :heavy_check_mark: | N/A | -| `price_currency` | [Optional[models.PresentmentCurrency]](../models/presentmentcurrency.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `amount_type` | *Literal["free"]* | :heavy_check_mark: | N/A | +| `price_currency` | [Optional[models.PresentmentCurrency]](../models/presentmentcurrency.md) | :heavy_minus_sign: | N/A | +| `tax_behavior` | [OptionalNullable[models.TaxBehaviorOption]](../models/taxbehavioroption.md) | :heavy_minus_sign: | The tax behavior of the price. If not set, it will default to the organization's default tax behavior. | \ No newline at end of file diff --git a/docs/models/productpricemeteredunit.md b/docs/models/productpricemeteredunit.md index d669dede..6c81872c 100644 --- a/docs/models/productpricemeteredunit.md +++ b/docs/models/productpricemeteredunit.md @@ -5,17 +5,18 @@ A metered, usage-based, price for a product, with a fixed unit price. ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Creation timestamp of the object. | -| `modified_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Last modification timestamp of the object. | -| `id` | *str* | :heavy_check_mark: | The ID of the price. | -| `source` | [models.ProductPriceSource](../models/productpricesource.md) | :heavy_check_mark: | N/A | -| `amount_type` | *Literal["metered_unit"]* | :heavy_check_mark: | N/A | -| `price_currency` | *str* | :heavy_check_mark: | The currency in which the customer will be charged. | -| `is_archived` | *bool* | :heavy_check_mark: | Whether the price is archived and no longer available. | -| `product_id` | *str* | :heavy_check_mark: | The ID of the product owning the price. | -| `unit_amount` | *str* | :heavy_check_mark: | The price per unit in cents. | -| `cap_amount` | *Nullable[int]* | :heavy_check_mark: | The maximum amount in cents that can be charged, regardless of the number of units consumed. | -| `meter_id` | *str* | :heavy_check_mark: | The ID of the meter associated to the price. | -| `meter` | [models.ProductPriceMeter](../models/productpricemeter.md) | :heavy_check_mark: | A meter associated to a metered price. | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `created_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Creation timestamp of the object. | +| `modified_at` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Last modification timestamp of the object. | +| `id` | *str* | :heavy_check_mark: | The ID of the price. | +| `source` | [models.ProductPriceSource](../models/productpricesource.md) | :heavy_check_mark: | N/A | +| `amount_type` | *Literal["metered_unit"]* | :heavy_check_mark: | N/A | +| `price_currency` | *str* | :heavy_check_mark: | The currency in which the customer will be charged. | +| `tax_behavior` | [Nullable[models.TaxBehaviorOption]](../models/taxbehavioroption.md) | :heavy_check_mark: | The tax behavior of the price. If null, it defaults to the organization's default tax behavior. | +| `is_archived` | *bool* | :heavy_check_mark: | Whether the price is archived and no longer available. | +| `product_id` | *str* | :heavy_check_mark: | The ID of the product owning the price. | +| `unit_amount` | *str* | :heavy_check_mark: | The price per unit in cents. | +| `cap_amount` | *Nullable[int]* | :heavy_check_mark: | The maximum amount in cents that can be charged, regardless of the number of units consumed. | +| `meter_id` | *str* | :heavy_check_mark: | The ID of the meter associated to the price. | +| `meter` | [models.ProductPriceMeter](../models/productpricemeter.md) | :heavy_check_mark: | A meter associated to a metered price. | \ No newline at end of file diff --git a/docs/models/productpricemeteredunitcreate.md b/docs/models/productpricemeteredunitcreate.md index c6f04ac8..e802a73f 100644 --- a/docs/models/productpricemeteredunitcreate.md +++ b/docs/models/productpricemeteredunitcreate.md @@ -5,10 +5,11 @@ Schema to create a metered price with a fixed unit price. ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `amount_type` | *Literal["metered_unit"]* | :heavy_check_mark: | N/A | -| `price_currency` | [Optional[models.PresentmentCurrency]](../models/presentmentcurrency.md) | :heavy_minus_sign: | N/A | -| `meter_id` | *str* | :heavy_check_mark: | The ID of the meter associated to the price. | -| `unit_amount` | [models.UnitAmount](../models/unitamount.md) | :heavy_check_mark: | The price per unit in cents. Supports up to 12 decimal places. | -| `cap_amount` | *OptionalNullable[int]* | :heavy_minus_sign: | Optional maximum amount in cents that can be charged, regardless of the number of units consumed. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `amount_type` | *Literal["metered_unit"]* | :heavy_check_mark: | N/A | +| `price_currency` | [Optional[models.PresentmentCurrency]](../models/presentmentcurrency.md) | :heavy_minus_sign: | N/A | +| `tax_behavior` | [OptionalNullable[models.TaxBehaviorOption]](../models/taxbehavioroption.md) | :heavy_minus_sign: | The tax behavior of the price. If not set, it will default to the organization's default tax behavior. | +| `meter_id` | *str* | :heavy_check_mark: | The ID of the meter associated to the price. | +| `unit_amount` | [models.UnitAmount](../models/unitamount.md) | :heavy_check_mark: | The price per unit in cents. Supports up to 12 decimal places. | +| `cap_amount` | *OptionalNullable[int]* | :heavy_minus_sign: | Optional maximum amount in cents that can be charged, regardless of the number of units consumed. | \ No newline at end of file diff --git a/docs/models/productpriceseatbased.md b/docs/models/productpriceseatbased.md index e57faac3..3dbc81ef 100644 --- a/docs/models/productpriceseatbased.md +++ b/docs/models/productpriceseatbased.md @@ -13,6 +13,7 @@ A seat-based price for a product. | `source` | [models.ProductPriceSource](../models/productpricesource.md) | :heavy_check_mark: | N/A | | `amount_type` | *Literal["seat_based"]* | :heavy_check_mark: | N/A | | `price_currency` | *str* | :heavy_check_mark: | The currency in which the customer will be charged. | +| `tax_behavior` | [Nullable[models.TaxBehaviorOption]](../models/taxbehavioroption.md) | :heavy_check_mark: | The tax behavior of the price. If null, it defaults to the organization's default tax behavior. | | `is_archived` | *bool* | :heavy_check_mark: | Whether the price is archived and no longer available. | | `product_id` | *str* | :heavy_check_mark: | The ID of the product owning the price. | | `seat_tiers` | [models.ProductPriceSeatTiersOutput](../models/productpriceseattiersoutput.md) | :heavy_check_mark: | List of pricing tiers for seat-based pricing.

The minimum and maximum seat limits are derived from the tiers:
- minimum_seats = first tier's min_seats
- maximum_seats = last tier's max_seats (None for unlimited) | \ No newline at end of file diff --git a/docs/models/productpriceseatbasedcreate.md b/docs/models/productpriceseatbasedcreate.md index f7c1f7cd..8cf5060d 100644 --- a/docs/models/productpriceseatbasedcreate.md +++ b/docs/models/productpriceseatbasedcreate.md @@ -9,4 +9,5 @@ Schema to create a seat-based price with volume-based tiers. | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `amount_type` | *Literal["seat_based"]* | :heavy_check_mark: | N/A | | `price_currency` | [Optional[models.PresentmentCurrency]](../models/presentmentcurrency.md) | :heavy_minus_sign: | N/A | +| `tax_behavior` | [OptionalNullable[models.TaxBehaviorOption]](../models/taxbehavioroption.md) | :heavy_minus_sign: | The tax behavior of the price. If not set, it will default to the organization's default tax behavior. | | `seat_tiers` | [models.ProductPriceSeatTiersInput](../models/productpriceseattiersinput.md) | :heavy_check_mark: | List of pricing tiers for seat-based pricing.

The minimum and maximum seat limits are derived from the tiers:
- minimum_seats = first tier's min_seats
- maximum_seats = last tier's max_seats (None for unlimited) | \ No newline at end of file diff --git a/docs/models/productpriceseattiersinput.md b/docs/models/productpriceseattiersinput.md index 523e4ac1..c748bcdc 100644 --- a/docs/models/productpriceseattiersinput.md +++ b/docs/models/productpriceseattiersinput.md @@ -11,4 +11,5 @@ The minimum and maximum seat limits are derived from the tiers: | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| `seat_tier_type` | [Optional[models.SeatTierType]](../models/seattiertype.md) | :heavy_minus_sign: | N/A | | `tiers` | List[[models.ProductPriceSeatTier](../models/productpriceseattier.md)] | :heavy_check_mark: | List of pricing tiers | \ No newline at end of file diff --git a/docs/models/productpriceseattiersoutput.md b/docs/models/productpriceseattiersoutput.md index 1ea05a88..56862d30 100644 --- a/docs/models/productpriceseattiersoutput.md +++ b/docs/models/productpriceseattiersoutput.md @@ -11,6 +11,7 @@ The minimum and maximum seat limits are derived from the tiers: | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `seat_tier_type` | [Optional[models.SeatTierType]](../models/seattiertype.md) | :heavy_minus_sign: | N/A | | `tiers` | List[[models.ProductPriceSeatTier](../models/productpriceseattier.md)] | :heavy_check_mark: | List of pricing tiers | | `minimum_seats` | *int* | :heavy_check_mark: | Minimum number of seats required for purchase, derived from first tier. | | `maximum_seats` | *Nullable[int]* | :heavy_check_mark: | Maximum number of seats allowed for purchase, derived from last tier. None for unlimited. | \ No newline at end of file diff --git a/docs/models/seatassign.md b/docs/models/seatassign.md index 4d468085..55cb4ad8 100644 --- a/docs/models/seatassign.md +++ b/docs/models/seatassign.md @@ -3,15 +3,15 @@ ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `subscription_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Subscription ID. Required if checkout_id and order_id are not provided. | -| `checkout_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Checkout ID. Used to look up subscription or order from the checkout page. | -| `order_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Order ID for one-time purchases. Required if subscription_id and checkout_id are not provided. | -| `email` | *OptionalNullable[str]* | :heavy_minus_sign: | Email of the customer to assign the seat to | -| `external_customer_id` | *OptionalNullable[str]* | :heavy_minus_sign: | External customer ID for the seat assignment | -| `customer_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Customer ID for the seat assignment | -| `external_member_id` | *OptionalNullable[str]* | :heavy_minus_sign: | External member ID for the seat assignment. Only supported when member_model_enabled is true. Can be used alone (lookup existing member) or with email (create/validate member). | -| `member_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Member ID for the seat assignment. Only supported when member_model_enabled is true. | -| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Additional metadata for the seat (max 10 keys, 1KB total) | -| `immediate_claim` | *Optional[bool]* | :heavy_minus_sign: | If true, the seat will be immediately claimed without sending an invitation email. API-only feature. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `subscription_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Subscription ID. Required if checkout_id and order_id are not provided. | +| `checkout_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Checkout ID. Used to look up subscription or order from the checkout page. | +| `order_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Order ID for one-time purchases. Required if subscription_id and checkout_id are not provided. | +| `email` | *OptionalNullable[str]* | :heavy_minus_sign: | Email of the customer to assign the seat to | +| `external_customer_id` | *OptionalNullable[str]* | :heavy_minus_sign: | External customer ID for the seat assignment | +| `customer_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Customer ID for the seat assignment | +| `external_member_id` | *OptionalNullable[str]* | :heavy_minus_sign: | External member ID for the seat assignment. Can be used alone (lookup existing member) or with email (create/validate member). | +| `member_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Member ID for the seat assignment. | +| `metadata` | Dict[str, *Any*] | :heavy_minus_sign: | Additional metadata for the seat (max 10 keys, 1KB total) | +| `immediate_claim` | *Optional[bool]* | :heavy_minus_sign: | If true, the seat will be immediately claimed without sending an invitation email. API-only feature. | \ No newline at end of file diff --git a/docs/models/seattiertype.md b/docs/models/seattiertype.md new file mode 100644 index 00000000..b17af8ab --- /dev/null +++ b/docs/models/seattiertype.md @@ -0,0 +1,9 @@ +# SeatTierType + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `VOLUME` | volume | +| `GRADUATED` | graduated | \ No newline at end of file diff --git a/docs/models/subscription.md b/docs/models/subscription.md index a2e25ae4..9cffcf4a 100644 --- a/docs/models/subscription.md +++ b/docs/models/subscription.md @@ -35,4 +35,5 @@ | `product` | [models.Product](../models/product.md) | :heavy_check_mark: | A product. | | | `discount` | [Nullable[models.SubscriptionDiscount]](../models/subscriptiondiscount.md) | :heavy_check_mark: | N/A | | | `prices` | List[[models.SubscriptionPrices](../models/subscriptionprices.md)] | :heavy_check_mark: | List of enabled prices for the subscription. | | -| `meters` | List[[models.SubscriptionMeter](../models/subscriptionmeter.md)] | :heavy_check_mark: | List of meters associated with the subscription. | | \ No newline at end of file +| `meters` | List[[models.SubscriptionMeter](../models/subscriptionmeter.md)] | :heavy_check_mark: | List of meters associated with the subscription. | | +| `pending_update` | [Nullable[models.PendingSubscriptionUpdate]](../models/pendingsubscriptionupdate.md) | :heavy_check_mark: | Pending subscription update that will be applied at the beginning of the next period. If `null`, there is no pending update. | | \ No newline at end of file diff --git a/docs/models/taxbehavioroption.md b/docs/models/taxbehavioroption.md new file mode 100644 index 00000000..58afe681 --- /dev/null +++ b/docs/models/taxbehavioroption.md @@ -0,0 +1,10 @@ +# TaxBehaviorOption + + +## Values + +| Name | Value | +| ----------- | ----------- | +| `LOCATION` | location | +| `INCLUSIVE` | inclusive | +| `EXCLUSIVE` | exclusive | \ No newline at end of file diff --git a/docs/sdks/checkouts/README.md b/docs/sdks/checkouts/README.md index 9f834d15..93563aa4 100644 --- a/docs/sdks/checkouts/README.md +++ b/docs/sdks/checkouts/README.md @@ -86,7 +86,7 @@ with Polar( res = polar.checkouts.create(request={ "customer_name": "John Doe", "customer_billing_address": { - "country": polar_sdk.CountryAlpha2Input.US, + "country": polar_sdk.AddressInputCountryAlpha2Input.US, }, "locale": "en", "products": [ @@ -183,7 +183,7 @@ with Polar( res = polar.checkouts.update(id="", checkout_update={ "customer_name": "John Doe", "customer_billing_address": { - "country": polar_sdk.CountryAlpha2Input.US, + "country": polar_sdk.AddressInputCountryAlpha2Input.US, }, "locale": "en", }) @@ -328,7 +328,7 @@ with Polar( res = polar.checkouts.client_confirm(client_secret="", checkout_confirm_stripe={ "customer_name": "John Doe", "customer_billing_address": { - "country": polar_sdk.CountryAlpha2Input.US, + "country": polar_sdk.AddressInputCountryAlpha2Input.US, }, "locale": "en", "allow_trial": False, diff --git a/docs/sdks/customers/README.md b/docs/sdks/customers/README.md index 95129a5c..fe20ddd5 100644 --- a/docs/sdks/customers/README.md +++ b/docs/sdks/customers/README.md @@ -90,7 +90,7 @@ with Polar( "email": "customer@example.com", "name": "John Doe", "billing_address": { - "country": polar_sdk.CountryAlpha2Input.US, + "country": polar_sdk.AddressInputCountryAlpha2Input.US, }, "locale": "en", "type": polar_sdk.CustomerType.INDIVIDUAL, @@ -232,7 +232,7 @@ with Polar( "email": "customer@example.com", "name": "John Doe", "billing_address": { - "country": polar_sdk.CountryAlpha2Input.US, + "country": polar_sdk.AddressInputCountryAlpha2Input.US, }, "locale": "en", "external_id": "usr_1337", diff --git a/docs/sdks/members/README.md b/docs/sdks/members/README.md index d54964ab..c7204ba2 100644 --- a/docs/sdks/members/README.md +++ b/docs/sdks/members/README.md @@ -43,6 +43,7 @@ with Polar( | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `customer_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Filter by customer ID. | | `external_customer_id` | *OptionalNullable[str]* | :heavy_minus_sign: | Filter by customer external ID. | +| `role` | [OptionalNullable[models.MemberRole]](../../models/memberrole.md) | :heavy_minus_sign: | Filter by member role. | | `page` | *Optional[int]* | :heavy_minus_sign: | Page number, defaults to 1. | | `limit` | *Optional[int]* | :heavy_minus_sign: | Size of a page, defaults to 10. Maximum is 100. | | `sorting` | List[[models.MemberSortProperty](../../models/membersortproperty.md)] | :heavy_minus_sign: | Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order. | diff --git a/docs/sdks/orders/README.md b/docs/sdks/orders/README.md index 4d1c71df..7103363e 100644 --- a/docs/sdks/orders/README.md +++ b/docs/sdks/orders/README.md @@ -172,7 +172,7 @@ with Polar( res = polar.orders.update(id="", order_update={ "billing_address": { - "country": polar_sdk.CountryAlpha2Input.US, + "country": polar_sdk.AddressInputCountryAlpha2Input.US, }, }) diff --git a/docs/sdks/polarcustomers/README.md b/docs/sdks/polarcustomers/README.md index 6709b4d3..20e3b9dc 100644 --- a/docs/sdks/polarcustomers/README.md +++ b/docs/sdks/polarcustomers/README.md @@ -72,7 +72,7 @@ with Polar() as polar: customer_session="", ), request={ "billing_address": { - "country": polar_sdk.CountryAlpha2Input.US, + "country": polar_sdk.AddressInputCountryAlpha2Input.US, }, }) diff --git a/docs/sdks/polarorders/README.md b/docs/sdks/polarorders/README.md index 9c09c7b5..c585a26c 100644 --- a/docs/sdks/polarorders/README.md +++ b/docs/sdks/polarorders/README.md @@ -124,7 +124,7 @@ with Polar() as polar: customer_session="", ), id="", customer_order_update={ "billing_address": { - "country": polar_sdk.CountryAlpha2Input.US, + "country": polar_sdk.AddressInputCountryAlpha2Input.US, }, }) diff --git a/docs/sdks/polarsubscriptions/README.md b/docs/sdks/polarsubscriptions/README.md index 8da25c10..adb9f158 100644 --- a/docs/sdks/polarsubscriptions/README.md +++ b/docs/sdks/polarsubscriptions/README.md @@ -146,6 +146,7 @@ with Polar() as polar: | Error Type | Status Code | Content Type | | ---------------------------------- | ---------------------------------- | ---------------------------------- | +| models.PaymentFailed | 402 | application/json | | models.AlreadyCanceledSubscription | 403 | application/json | | models.ResourceNotFound | 404 | application/json | | models.HTTPValidationError | 422 | application/json | diff --git a/docs/sdks/subscriptions/README.md b/docs/sdks/subscriptions/README.md index c8bb418d..9fe18765 100644 --- a/docs/sdks/subscriptions/README.md +++ b/docs/sdks/subscriptions/README.md @@ -243,6 +243,7 @@ with Polar( | Error Type | Status Code | Content Type | | ---------------------------------- | ---------------------------------- | ---------------------------------- | +| models.PaymentFailed | 402 | application/json | | models.AlreadyCanceledSubscription | 403 | application/json | | models.ResourceNotFound | 404 | application/json | | models.SubscriptionLocked | 409 | application/json | diff --git a/pyproject.toml b/pyproject.toml index 22c8683e..45233724 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,7 @@ [project] name = "polar-sdk" -version = "0.30.1" +version = "0.30.2" description = "Polar SDK for Python" authors = [{ name = "Polar" },] readme = "README-PYPI.md" diff --git a/src/polar_sdk/_version.py b/src/polar_sdk/_version.py index 9fd1f5b5..10c62113 100644 --- a/src/polar_sdk/_version.py +++ b/src/polar_sdk/_version.py @@ -3,10 +3,10 @@ import importlib.metadata __title__: str = "polar-sdk" -__version__: str = "0.30.1" +__version__: str = "0.30.2" __openapi_doc_version__: str = "0.1.0" __gen_version__: str = "2.737.0" -__user_agent__: str = "speakeasy-sdk/python 0.30.1 2.737.0 0.1.0 polar-sdk" +__user_agent__: str = "speakeasy-sdk/python 0.30.2 2.737.0 0.1.0 polar-sdk" try: if __package__ is not None: diff --git a/src/polar_sdk/members.py b/src/polar_sdk/members.py index ed7222f6..9e13c9c9 100644 --- a/src/polar_sdk/members.py +++ b/src/polar_sdk/members.py @@ -15,6 +15,7 @@ def list_members( *, customer_id: OptionalNullable[str] = UNSET, external_customer_id: OptionalNullable[str] = UNSET, + role: OptionalNullable[models.MemberRole] = UNSET, page: Optional[int] = 1, limit: Optional[int] = 10, sorting: OptionalNullable[List[models.MemberSortProperty]] = UNSET, @@ -31,6 +32,7 @@ def list_members( :param customer_id: Filter by customer ID. :param external_customer_id: Filter by customer external ID. + :param role: Filter by member role. :param page: Page number, defaults to 1. :param limit: Size of a page, defaults to 10. Maximum is 100. :param sorting: Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order. @@ -52,6 +54,7 @@ def list_members( request = models.MembersListMembersRequest( customer_id=customer_id, external_customer_id=external_customer_id, + role=role, page=page, limit=limit, sorting=sorting, @@ -115,6 +118,7 @@ def next_func() -> Optional[models.MembersListMembersResponse]: return self.list_members( customer_id=customer_id, external_customer_id=external_customer_id, + role=role, page=next_page, limit=limit, sorting=sorting, @@ -146,6 +150,7 @@ async def list_members_async( *, customer_id: OptionalNullable[str] = UNSET, external_customer_id: OptionalNullable[str] = UNSET, + role: OptionalNullable[models.MemberRole] = UNSET, page: Optional[int] = 1, limit: Optional[int] = 10, sorting: OptionalNullable[List[models.MemberSortProperty]] = UNSET, @@ -162,6 +167,7 @@ async def list_members_async( :param customer_id: Filter by customer ID. :param external_customer_id: Filter by customer external ID. + :param role: Filter by member role. :param page: Page number, defaults to 1. :param limit: Size of a page, defaults to 10. Maximum is 100. :param sorting: Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order. @@ -183,6 +189,7 @@ async def list_members_async( request = models.MembersListMembersRequest( customer_id=customer_id, external_customer_id=external_customer_id, + role=role, page=page, limit=limit, sorting=sorting, @@ -246,6 +253,7 @@ def next_func() -> Optional[models.MembersListMembersResponse]: return self.list_members( customer_id=customer_id, external_customer_id=external_customer_id, + role=role, page=next_page, limit=limit, sorting=sorting, diff --git a/src/polar_sdk/models/__init__.py b/src/polar_sdk/models/__init__.py index 10a1b70f..d288d5a0 100644 --- a/src/polar_sdk/models/__init__.py +++ b/src/polar_sdk/models/__init__.py @@ -8,9 +8,13 @@ import sys if TYPE_CHECKING: - from .address import Address, AddressTypedDict, CountryAlpha2 + from .address import Address, AddressCountryAlpha2, AddressTypedDict from .addressdict import AddressDict, AddressDictTypedDict - from .addressinput import AddressInput, AddressInputTypedDict, CountryAlpha2Input + from .addressinput import ( + AddressInput, + AddressInputCountryAlpha2Input, + AddressInputTypedDict, + ) from .aggregationfunction import AggregationFunction from .alreadyactivesubscriptionerror import ( AlreadyActiveSubscriptionError, @@ -2172,7 +2176,7 @@ from .orderstatus import OrderStatus from .ordersubscription import OrderSubscription, OrderSubscriptionTypedDict from .orderupdate import OrderUpdate, OrderUpdateTypedDict - from .organization import Organization, OrganizationTypedDict + from .organization import CountryAlpha2, Organization, OrganizationTypedDict from .organization_access_tokens_deleteop import ( OrganizationAccessTokensDeleteRequest, OrganizationAccessTokensDeleteRequestTypedDict, @@ -2214,7 +2218,17 @@ OrganizationAvatarFileRead, OrganizationAvatarFileReadTypedDict, ) - from .organizationcreate import OrganizationCreate, OrganizationCreateTypedDict + from .organizationcompanylegalentityschema import ( + OrganizationCompanyLegalEntitySchema, + OrganizationCompanyLegalEntitySchemaTypedDict, + ) + from .organizationcreate import ( + CountryAlpha2Input, + LegalEntity, + LegalEntityTypedDict, + OrganizationCreate, + OrganizationCreateTypedDict, + ) from .organizationcustomeremailsettings import ( OrganizationCustomerEmailSettings, OrganizationCustomerEmailSettingsTypedDict, @@ -2232,6 +2246,10 @@ OrganizationFeatureSettings, OrganizationFeatureSettingsTypedDict, ) + from .organizationindividuallegalentityschema import ( + OrganizationIndividualLegalEntitySchema, + OrganizationIndividualLegalEntitySchemaTypedDict, + ) from .organizationnotificationsettings import ( OrganizationNotificationSettings, OrganizationNotificationSettingsTypedDict, @@ -2261,7 +2279,11 @@ OrganizationSubscriptionSettings, OrganizationSubscriptionSettingsTypedDict, ) - from .organizationupdate import OrganizationUpdate, OrganizationUpdateTypedDict + from .organizationupdate import ( + CountryCountryAlpha2Input, + OrganizationUpdate, + OrganizationUpdateTypedDict, + ) from .ownercreate import OwnerCreate, OwnerCreateTypedDict from .pagination import Pagination, PaginationTypedDict from .payment import Payment, PaymentTypedDict @@ -2270,6 +2292,7 @@ PaymentAlreadyInProgressData, ) from .paymenterror import PaymentError, PaymentErrorData + from .paymentfailed import PaymentFailed, PaymentFailedData from .paymentmethodcard import PaymentMethodCard, PaymentMethodCardTypedDict from .paymentmethodcardmetadata import ( PaymentMethodCardMetadata, @@ -2306,6 +2329,10 @@ ) from .paymentsortproperty import PaymentSortProperty from .paymentstatus import PaymentStatus + from .pendingsubscriptionupdate import ( + PendingSubscriptionUpdate, + PendingSubscriptionUpdateTypedDict, + ) from .portalauthenticateduser import ( PortalAuthenticatedUser, PortalAuthenticatedUserTypedDict, @@ -2474,6 +2501,7 @@ from .seatclaiminfo import SeatClaimInfo, SeatClaimInfoTypedDict from .seatslist import SeatsList, SeatsListTypedDict from .seatstatus import SeatStatus + from .seattiertype import SeatTierType from .security import Security, SecurityTypedDict from .subscription import ( CustomFieldData, @@ -2738,6 +2766,7 @@ ) from .subtype import SubType from .systemevent import SystemEvent, SystemEventTypedDict + from .taxbehavioroption import TaxBehaviorOption from .taxidformat import TaxIDFormat from .timeinterval import TimeInterval from .tokenresponse import TokenResponse, TokenResponseTypedDict @@ -2966,9 +2995,11 @@ "ActiveUserByEvent", "ActiveUserByEventTypedDict", "Address", + "AddressCountryAlpha2", "AddressDict", "AddressDictTypedDict", "AddressInput", + "AddressInputCountryAlpha2Input", "AddressInputTypedDict", "AddressTypedDict", "Aggregation", @@ -3436,6 +3467,7 @@ "CountAggregationTypedDict", "CountryAlpha2", "CountryAlpha2Input", + "CountryCountryAlpha2Input", "CumulativeCosts", "CumulativeCostsTypedDict", "CumulativeRevenue", @@ -4157,6 +4189,8 @@ "LegacyRecurringProductPriceFree", "LegacyRecurringProductPriceFreeTypedDict", "LegacyRecurringProductPriceTypedDict", + "LegalEntity", + "LegalEntityTypedDict", "LicenseKeyActivate", "LicenseKeyActivateConditions", "LicenseKeyActivateConditionsTypedDict", @@ -4596,6 +4630,8 @@ "OrganizationAvatarFileCreateTypedDict", "OrganizationAvatarFileRead", "OrganizationAvatarFileReadTypedDict", + "OrganizationCompanyLegalEntitySchema", + "OrganizationCompanyLegalEntitySchemaTypedDict", "OrganizationCreate", "OrganizationCreateTypedDict", "OrganizationCustomerEmailSettings", @@ -4610,6 +4646,8 @@ "OrganizationIDFilter", "OrganizationIDFilterTypedDict", "OrganizationIDTypedDict", + "OrganizationIndividualLegalEntitySchema", + "OrganizationIndividualLegalEntitySchemaTypedDict", "OrganizationNotificationSettings", "OrganizationNotificationSettingsTypedDict", "OrganizationSocialLink", @@ -4639,6 +4677,8 @@ "PaymentAlreadyInProgressData", "PaymentError", "PaymentErrorData", + "PaymentFailed", + "PaymentFailedData", "PaymentMethodCard", "PaymentMethodCardMetadata", "PaymentMethodCardMetadataTypedDict", @@ -4667,6 +4707,8 @@ "PaymentsListRequestTypedDict", "PaymentsListResponse", "PaymentsListResponseTypedDict", + "PendingSubscriptionUpdate", + "PendingSubscriptionUpdateTypedDict", "Permission", "PolarError", "PortalAuthenticatedUser", @@ -4853,6 +4895,7 @@ "SeatClaimInfoTypedDict", "SeatClaimTypedDict", "SeatStatus", + "SeatTierType", "SeatsList", "SeatsListTypedDict", "Security", @@ -4970,6 +5013,7 @@ "SwitchingFrom", "SystemEvent", "SystemEventTypedDict", + "TaxBehaviorOption", "TaxID", "TaxIDFormat", "TaxIDTypedDict", @@ -5110,13 +5154,13 @@ _dynamic_imports: dict[str, str] = { "Address": ".address", + "AddressCountryAlpha2": ".address", "AddressTypedDict": ".address", - "CountryAlpha2": ".address", "AddressDict": ".addressdict", "AddressDictTypedDict": ".addressdict", "AddressInput": ".addressinput", + "AddressInputCountryAlpha2Input": ".addressinput", "AddressInputTypedDict": ".addressinput", - "CountryAlpha2Input": ".addressinput", "AggregationFunction": ".aggregationfunction", "AlreadyActiveSubscriptionError": ".alreadyactivesubscriptionerror", "AlreadyActiveSubscriptionErrorData": ".alreadyactivesubscriptionerror", @@ -6679,6 +6723,7 @@ "OrderSubscriptionTypedDict": ".ordersubscription", "OrderUpdate": ".orderupdate", "OrderUpdateTypedDict": ".orderupdate", + "CountryAlpha2": ".organization", "Organization": ".organization", "OrganizationTypedDict": ".organization", "OrganizationAccessTokensDeleteRequest": ".organization_access_tokens_deleteop", @@ -6704,6 +6749,11 @@ "OrganizationAvatarFileCreateTypedDict": ".organizationavatarfilecreate", "OrganizationAvatarFileRead": ".organizationavatarfileread", "OrganizationAvatarFileReadTypedDict": ".organizationavatarfileread", + "OrganizationCompanyLegalEntitySchema": ".organizationcompanylegalentityschema", + "OrganizationCompanyLegalEntitySchemaTypedDict": ".organizationcompanylegalentityschema", + "CountryAlpha2Input": ".organizationcreate", + "LegalEntity": ".organizationcreate", + "LegalEntityTypedDict": ".organizationcreate", "OrganizationCreate": ".organizationcreate", "OrganizationCreateTypedDict": ".organizationcreate", "OrganizationCustomerEmailSettings": ".organizationcustomeremailsettings", @@ -6715,6 +6765,8 @@ "SwitchingFrom": ".organizationdetails", "OrganizationFeatureSettings": ".organizationfeaturesettings", "OrganizationFeatureSettingsTypedDict": ".organizationfeaturesettings", + "OrganizationIndividualLegalEntitySchema": ".organizationindividuallegalentityschema", + "OrganizationIndividualLegalEntitySchemaTypedDict": ".organizationindividuallegalentityschema", "OrganizationNotificationSettings": ".organizationnotificationsettings", "OrganizationNotificationSettingsTypedDict": ".organizationnotificationsettings", "OrganizationsGetRequest": ".organizations_getop", @@ -6732,6 +6784,7 @@ "OrganizationStatus": ".organizationstatus", "OrganizationSubscriptionSettings": ".organizationsubscriptionsettings", "OrganizationSubscriptionSettingsTypedDict": ".organizationsubscriptionsettings", + "CountryCountryAlpha2Input": ".organizationupdate", "OrganizationUpdate": ".organizationupdate", "OrganizationUpdateTypedDict": ".organizationupdate", "OwnerCreate": ".ownercreate", @@ -6744,6 +6797,8 @@ "PaymentAlreadyInProgressData": ".paymentalreadyinprogress", "PaymentError": ".paymenterror", "PaymentErrorData": ".paymenterror", + "PaymentFailed": ".paymentfailed", + "PaymentFailedData": ".paymentfailed", "PaymentMethodCard": ".paymentmethodcard", "PaymentMethodCardTypedDict": ".paymentmethodcard", "PaymentMethodCardMetadata": ".paymentmethodcardmetadata", @@ -6775,6 +6830,8 @@ "PaymentsListResponseTypedDict": ".payments_listop", "PaymentSortProperty": ".paymentsortproperty", "PaymentStatus": ".paymentstatus", + "PendingSubscriptionUpdate": ".pendingsubscriptionupdate", + "PendingSubscriptionUpdateTypedDict": ".pendingsubscriptionupdate", "PortalAuthenticatedUser": ".portalauthenticateduser", "PortalAuthenticatedUserTypedDict": ".portalauthenticateduser", "PresentmentCurrency": ".presentmentcurrency", @@ -6917,6 +6974,7 @@ "SeatsList": ".seatslist", "SeatsListTypedDict": ".seatslist", "SeatStatus": ".seatstatus", + "SeatTierType": ".seattiertype", "Security": ".security", "SecurityTypedDict": ".security", "CustomFieldData": ".subscription", @@ -7114,6 +7172,7 @@ "SubType": ".subtype", "SystemEvent": ".systemevent", "SystemEventTypedDict": ".systemevent", + "TaxBehaviorOption": ".taxbehavioroption", "TaxIDFormat": ".taxidformat", "TimeInterval": ".timeinterval", "TokenResponse": ".tokenresponse", diff --git a/src/polar_sdk/models/address.py b/src/polar_sdk/models/address.py index 0d49058c..4beb49cb 100644 --- a/src/polar_sdk/models/address.py +++ b/src/polar_sdk/models/address.py @@ -7,7 +7,7 @@ from typing_extensions import NotRequired, TypedDict -class CountryAlpha2(str, Enum): +class AddressCountryAlpha2(str, Enum): AD = "AD" AE = "AE" AF = "AF" @@ -260,7 +260,7 @@ class CountryAlpha2(str, Enum): class AddressTypedDict(TypedDict): - country: CountryAlpha2 + country: AddressCountryAlpha2 line1: NotRequired[Nullable[str]] line2: NotRequired[Nullable[str]] postal_code: NotRequired[Nullable[str]] @@ -269,7 +269,7 @@ class AddressTypedDict(TypedDict): class Address(BaseModel): - country: CountryAlpha2 + country: AddressCountryAlpha2 line1: OptionalNullable[str] = UNSET diff --git a/src/polar_sdk/models/addressinput.py b/src/polar_sdk/models/addressinput.py index 12dfff70..14cf6ed8 100644 --- a/src/polar_sdk/models/addressinput.py +++ b/src/polar_sdk/models/addressinput.py @@ -7,7 +7,7 @@ from typing_extensions import NotRequired, TypedDict -class CountryAlpha2Input(str, Enum): +class AddressInputCountryAlpha2Input(str, Enum): AD = "AD" AE = "AE" AF = "AF" @@ -255,7 +255,7 @@ class CountryAlpha2Input(str, Enum): class AddressInputTypedDict(TypedDict): - country: CountryAlpha2Input + country: AddressInputCountryAlpha2Input line1: NotRequired[Nullable[str]] line2: NotRequired[Nullable[str]] postal_code: NotRequired[Nullable[str]] @@ -264,7 +264,7 @@ class AddressInputTypedDict(TypedDict): class AddressInput(BaseModel): - country: CountryAlpha2Input + country: AddressInputCountryAlpha2Input line1: OptionalNullable[str] = UNSET diff --git a/src/polar_sdk/models/checkout.py b/src/polar_sdk/models/checkout.py index 480a5dd8..45bb60ac 100644 --- a/src/polar_sdk/models/checkout.py +++ b/src/polar_sdk/models/checkout.py @@ -210,8 +210,6 @@ class CheckoutTypedDict(TypedDict): r"""Minimum number of seats (works with seat-based pricing only)""" max_seats: NotRequired[Nullable[int]] r"""Maximum number of seats (works with seat-based pricing only)""" - price_per_seat: NotRequired[Nullable[int]] - r"""Price per seat in cents for the current seat count, based on the applicable tier. Only relevant for seat-based pricing.""" locale: NotRequired[Nullable[str]] @@ -388,9 +386,6 @@ class Checkout(BaseModel): max_seats: OptionalNullable[int] = UNSET r"""Maximum number of seats (works with seat-based pricing only)""" - price_per_seat: OptionalNullable[int] = UNSET - r"""Price per seat in cents for the current seat count, based on the applicable tier. Only relevant for seat-based pricing.""" - locale: OptionalNullable[str] = UNSET @model_serializer(mode="wrap") @@ -400,7 +395,6 @@ def serialize_model(self, handler): "seats", "min_seats", "max_seats", - "price_per_seat", "locale", ] nullable_fields = [ @@ -410,7 +404,6 @@ def serialize_model(self, handler): "seats", "min_seats", "max_seats", - "price_per_seat", "tax_amount", "allow_trial", "active_trial_interval", diff --git a/src/polar_sdk/models/checkoutpublic.py b/src/polar_sdk/models/checkoutpublic.py index ba9d76ce..9fdfc74b 100644 --- a/src/polar_sdk/models/checkoutpublic.py +++ b/src/polar_sdk/models/checkoutpublic.py @@ -194,8 +194,6 @@ class CheckoutPublicTypedDict(TypedDict): r"""Minimum number of seats (works with seat-based pricing only)""" max_seats: NotRequired[Nullable[int]] r"""Maximum number of seats (works with seat-based pricing only)""" - price_per_seat: NotRequired[Nullable[int]] - r"""Price per seat in cents for the current seat count, based on the applicable tier. Only relevant for seat-based pricing.""" locale: NotRequired[Nullable[str]] @@ -361,9 +359,6 @@ class CheckoutPublic(BaseModel): max_seats: OptionalNullable[int] = UNSET r"""Maximum number of seats (works with seat-based pricing only)""" - price_per_seat: OptionalNullable[int] = UNSET - r"""Price per seat in cents for the current seat count, based on the applicable tier. Only relevant for seat-based pricing.""" - locale: OptionalNullable[str] = UNSET @model_serializer(mode="wrap") @@ -373,7 +368,6 @@ def serialize_model(self, handler): "seats", "min_seats", "max_seats", - "price_per_seat", "locale", ] nullable_fields = [ @@ -383,7 +377,6 @@ def serialize_model(self, handler): "seats", "min_seats", "max_seats", - "price_per_seat", "tax_amount", "allow_trial", "active_trial_interval", diff --git a/src/polar_sdk/models/checkoutpublicconfirmed.py b/src/polar_sdk/models/checkoutpublicconfirmed.py index a5d72f0e..31df4f18 100644 --- a/src/polar_sdk/models/checkoutpublicconfirmed.py +++ b/src/polar_sdk/models/checkoutpublicconfirmed.py @@ -201,8 +201,6 @@ class CheckoutPublicConfirmedTypedDict(TypedDict): r"""Minimum number of seats (works with seat-based pricing only)""" max_seats: NotRequired[Nullable[int]] r"""Maximum number of seats (works with seat-based pricing only)""" - price_per_seat: NotRequired[Nullable[int]] - r"""Price per seat in cents for the current seat count, based on the applicable tier. Only relevant for seat-based pricing.""" locale: NotRequired[Nullable[str]] @@ -377,9 +375,6 @@ class CheckoutPublicConfirmed(BaseModel): max_seats: OptionalNullable[int] = UNSET r"""Maximum number of seats (works with seat-based pricing only)""" - price_per_seat: OptionalNullable[int] = UNSET - r"""Price per seat in cents for the current seat count, based on the applicable tier. Only relevant for seat-based pricing.""" - locale: OptionalNullable[str] = UNSET @model_serializer(mode="wrap") @@ -389,7 +384,6 @@ def serialize_model(self, handler): "seats", "min_seats", "max_seats", - "price_per_seat", "locale", ] nullable_fields = [ @@ -399,7 +393,6 @@ def serialize_model(self, handler): "seats", "min_seats", "max_seats", - "price_per_seat", "tax_amount", "allow_trial", "active_trial_interval", diff --git a/src/polar_sdk/models/customersubscription.py b/src/polar_sdk/models/customersubscription.py index 226fc45e..007f7be2 100644 --- a/src/polar_sdk/models/customersubscription.py +++ b/src/polar_sdk/models/customersubscription.py @@ -14,6 +14,10 @@ LegacyRecurringProductPrice, LegacyRecurringProductPriceTypedDict, ) +from .pendingsubscriptionupdate import ( + PendingSubscriptionUpdate, + PendingSubscriptionUpdateTypedDict, +) from .productprice import ProductPrice, ProductPriceTypedDict from .subscriptionrecurringinterval import SubscriptionRecurringInterval from .subscriptionstatus import SubscriptionStatus @@ -82,6 +86,8 @@ class CustomerSubscriptionTypedDict(TypedDict): r"""List of enabled prices for the subscription.""" meters: List[CustomerSubscriptionMeterTypedDict] r"""List of meters associated with the subscription.""" + pending_update: Nullable[PendingSubscriptionUpdateTypedDict] + r"""Pending subscription update that will be applied at the beginning of the next period. If `null`, there is no pending update.""" seats: NotRequired[Nullable[int]] r"""The number of seats for seat-based subscriptions. None for non-seat subscriptions.""" @@ -159,6 +165,9 @@ class CustomerSubscription(BaseModel): meters: List[CustomerSubscriptionMeter] r"""List of meters associated with the subscription.""" + pending_update: Nullable[PendingSubscriptionUpdate] + r"""Pending subscription update that will be applied at the beginning of the next period. If `null`, there is no pending update.""" + seats: OptionalNullable[int] = UNSET r"""The number of seats for seat-based subscriptions. None for non-seat subscriptions.""" @@ -178,6 +187,7 @@ def serialize_model(self, handler): "seats", "customer_cancellation_reason", "customer_cancellation_comment", + "pending_update", ] null_default_fields = [] diff --git a/src/polar_sdk/models/legacyrecurringproductpricecustom.py b/src/polar_sdk/models/legacyrecurringproductpricecustom.py index f7d52da4..3dfbb75e 100644 --- a/src/polar_sdk/models/legacyrecurringproductpricecustom.py +++ b/src/polar_sdk/models/legacyrecurringproductpricecustom.py @@ -3,6 +3,7 @@ from __future__ import annotations from .productpricesource import ProductPriceSource from .subscriptionrecurringinterval import SubscriptionRecurringInterval +from .taxbehavioroption import TaxBehaviorOption from datetime import datetime from polar_sdk.types import BaseModel, Nullable, UNSET_SENTINEL from polar_sdk.utils import validate_const @@ -28,6 +29,8 @@ class LegacyRecurringProductPriceCustomTypedDict(TypedDict): source: ProductPriceSource price_currency: str r"""The currency in which the customer will be charged.""" + tax_behavior: Nullable[TaxBehaviorOption] + r"""The tax behavior of the price. If null, it defaults to the organization's default tax behavior.""" is_archived: bool r"""Whether the price is archived and no longer available.""" product_id: str @@ -65,6 +68,9 @@ class LegacyRecurringProductPriceCustom(BaseModel): price_currency: str r"""The currency in which the customer will be charged.""" + tax_behavior: Nullable[TaxBehaviorOption] + r"""The tax behavior of the price. If null, it defaults to the organization's default tax behavior.""" + is_archived: bool r"""Whether the price is archived and no longer available.""" @@ -101,7 +107,12 @@ class LegacyRecurringProductPriceCustom(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [] - nullable_fields = ["modified_at", "maximum_amount", "preset_amount"] + nullable_fields = [ + "modified_at", + "tax_behavior", + "maximum_amount", + "preset_amount", + ] null_default_fields = [] serialized = handler(self) diff --git a/src/polar_sdk/models/legacyrecurringproductpricefixed.py b/src/polar_sdk/models/legacyrecurringproductpricefixed.py index e530ddc3..632d243d 100644 --- a/src/polar_sdk/models/legacyrecurringproductpricefixed.py +++ b/src/polar_sdk/models/legacyrecurringproductpricefixed.py @@ -3,6 +3,7 @@ from __future__ import annotations from .productpricesource import ProductPriceSource from .subscriptionrecurringinterval import SubscriptionRecurringInterval +from .taxbehavioroption import TaxBehaviorOption from datetime import datetime from polar_sdk.types import BaseModel, Nullable, UNSET_SENTINEL from polar_sdk.utils import validate_const @@ -28,6 +29,8 @@ class LegacyRecurringProductPriceFixedTypedDict(TypedDict): source: ProductPriceSource price_currency: str r"""The currency in which the customer will be charged.""" + tax_behavior: Nullable[TaxBehaviorOption] + r"""The tax behavior of the price. If null, it defaults to the organization's default tax behavior.""" is_archived: bool r"""Whether the price is archived and no longer available.""" product_id: str @@ -61,6 +64,9 @@ class LegacyRecurringProductPriceFixed(BaseModel): price_currency: str r"""The currency in which the customer will be charged.""" + tax_behavior: Nullable[TaxBehaviorOption] + r"""The tax behavior of the price. If null, it defaults to the organization's default tax behavior.""" + is_archived: bool r"""Whether the price is archived and no longer available.""" @@ -91,7 +97,7 @@ class LegacyRecurringProductPriceFixed(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [] - nullable_fields = ["modified_at"] + nullable_fields = ["modified_at", "tax_behavior"] null_default_fields = [] serialized = handler(self) diff --git a/src/polar_sdk/models/legacyrecurringproductpricefree.py b/src/polar_sdk/models/legacyrecurringproductpricefree.py index 640cc9b7..9165eb3b 100644 --- a/src/polar_sdk/models/legacyrecurringproductpricefree.py +++ b/src/polar_sdk/models/legacyrecurringproductpricefree.py @@ -3,6 +3,7 @@ from __future__ import annotations from .productpricesource import ProductPriceSource from .subscriptionrecurringinterval import SubscriptionRecurringInterval +from .taxbehavioroption import TaxBehaviorOption from datetime import datetime from polar_sdk.types import BaseModel, Nullable, UNSET_SENTINEL from polar_sdk.utils import validate_const @@ -28,6 +29,8 @@ class LegacyRecurringProductPriceFreeTypedDict(TypedDict): source: ProductPriceSource price_currency: str r"""The currency in which the customer will be charged.""" + tax_behavior: Nullable[TaxBehaviorOption] + r"""The tax behavior of the price. If null, it defaults to the organization's default tax behavior.""" is_archived: bool r"""Whether the price is archived and no longer available.""" product_id: str @@ -59,6 +62,9 @@ class LegacyRecurringProductPriceFree(BaseModel): price_currency: str r"""The currency in which the customer will be charged.""" + tax_behavior: Nullable[TaxBehaviorOption] + r"""The tax behavior of the price. If null, it defaults to the organization's default tax behavior.""" + is_archived: bool r"""Whether the price is archived and no longer available.""" @@ -86,7 +92,7 @@ class LegacyRecurringProductPriceFree(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [] - nullable_fields = ["modified_at"] + nullable_fields = ["modified_at", "tax_behavior"] null_default_fields = [] serialized = handler(self) diff --git a/src/polar_sdk/models/members_list_membersop.py b/src/polar_sdk/models/members_list_membersop.py index cce4864e..0babbd87 100644 --- a/src/polar_sdk/models/members_list_membersop.py +++ b/src/polar_sdk/models/members_list_membersop.py @@ -2,6 +2,7 @@ from __future__ import annotations from .listresource_member_ import ListResourceMember, ListResourceMemberTypedDict +from .memberrole import MemberRole from .membersortproperty import MemberSortProperty from polar_sdk.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL from polar_sdk.utils import FieldMetadata, QueryParamMetadata @@ -15,6 +16,8 @@ class MembersListMembersRequestTypedDict(TypedDict): r"""Filter by customer ID.""" external_customer_id: NotRequired[Nullable[str]] r"""Filter by customer external ID.""" + role: NotRequired[Nullable[MemberRole]] + r"""Filter by member role.""" page: NotRequired[int] r"""Page number, defaults to 1.""" limit: NotRequired[int] @@ -36,6 +39,12 @@ class MembersListMembersRequest(BaseModel): ] = UNSET r"""Filter by customer external ID.""" + role: Annotated[ + OptionalNullable[MemberRole], + FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), + ] = UNSET + r"""Filter by member role.""" + page: Annotated[ Optional[int], FieldMetadata(query=QueryParamMetadata(style="form", explode=True)), @@ -59,11 +68,12 @@ def serialize_model(self, handler): optional_fields = [ "customer_id", "external_customer_id", + "role", "page", "limit", "sorting", ] - nullable_fields = ["customer_id", "external_customer_id", "sorting"] + nullable_fields = ["customer_id", "external_customer_id", "role", "sorting"] null_default_fields = [] serialized = handler(self) diff --git a/src/polar_sdk/models/metricperiod.py b/src/polar_sdk/models/metricperiod.py index 1c5ea342..85f0244f 100644 --- a/src/polar_sdk/models/metricperiod.py +++ b/src/polar_sdk/models/metricperiod.py @@ -72,6 +72,12 @@ ChurnedSubscriptions = TypeAliasType("ChurnedSubscriptions", Union[int, float]) +ChurnRateTypedDict = TypeAliasType("ChurnRateTypedDict", Union[int, float]) + + +ChurnRate = TypeAliasType("ChurnRate", Union[int, float]) + + OrdersModelTypedDict = TypeAliasType("OrdersModelTypedDict", Union[int, float]) @@ -322,12 +328,6 @@ CheckoutsConversion = TypeAliasType("CheckoutsConversion", Union[int, float]) -ChurnRateTypedDict = TypeAliasType("ChurnRateTypedDict", Union[int, float]) - - -ChurnRate = TypeAliasType("ChurnRate", Union[int, float]) - - LtvTypedDict = TypeAliasType("LtvTypedDict", Union[int, float]) @@ -367,6 +367,7 @@ class MetricPeriodTypedDict(TypedDict): checkouts: NotRequired[Nullable[CheckoutsModelTypedDict]] succeeded_checkouts: NotRequired[Nullable[SucceededCheckoutsTypedDict]] churned_subscriptions: NotRequired[Nullable[ChurnedSubscriptionsTypedDict]] + churn_rate: NotRequired[Nullable[ChurnRateTypedDict]] orders: NotRequired[Nullable[OrdersModelTypedDict]] revenue: NotRequired[Nullable[RevenueTypedDict]] net_revenue: NotRequired[Nullable[NetRevenueTypedDict]] @@ -421,7 +422,6 @@ class MetricPeriodTypedDict(TypedDict): Nullable[CanceledSubscriptionsOtherTypedDict] ] checkouts_conversion: NotRequired[Nullable[CheckoutsConversionTypedDict]] - churn_rate: NotRequired[Nullable[ChurnRateTypedDict]] ltv: NotRequired[Nullable[LtvTypedDict]] gross_margin: NotRequired[Nullable[GrossMarginTypedDict]] gross_margin_percentage: NotRequired[Nullable[GrossMarginPercentageTypedDict]] @@ -450,6 +450,8 @@ class MetricPeriod(BaseModel): churned_subscriptions: OptionalNullable[ChurnedSubscriptions] = UNSET + churn_rate: OptionalNullable[ChurnRate] = UNSET + orders: OptionalNullable[OrdersModel] = UNSET revenue: OptionalNullable[Revenue] = UNSET @@ -524,8 +526,6 @@ class MetricPeriod(BaseModel): checkouts_conversion: OptionalNullable[CheckoutsConversion] = UNSET - churn_rate: OptionalNullable[ChurnRate] = UNSET - ltv: OptionalNullable[Ltv] = UNSET gross_margin: OptionalNullable[GrossMargin] = UNSET @@ -545,6 +545,7 @@ def serialize_model(self, handler): "checkouts", "succeeded_checkouts", "churned_subscriptions", + "churn_rate", "orders", "revenue", "net_revenue", @@ -575,7 +576,6 @@ def serialize_model(self, handler): "canceled_subscriptions_unused", "canceled_subscriptions_other", "checkouts_conversion", - "churn_rate", "ltv", "gross_margin", "gross_margin_percentage", @@ -590,6 +590,7 @@ def serialize_model(self, handler): "checkouts", "succeeded_checkouts", "churned_subscriptions", + "churn_rate", "orders", "revenue", "net_revenue", @@ -620,7 +621,6 @@ def serialize_model(self, handler): "canceled_subscriptions_unused", "canceled_subscriptions_other", "checkouts_conversion", - "churn_rate", "ltv", "gross_margin", "gross_margin_percentage", diff --git a/src/polar_sdk/models/metrics.py b/src/polar_sdk/models/metrics.py index 278d4cf1..40d9d64a 100644 --- a/src/polar_sdk/models/metrics.py +++ b/src/polar_sdk/models/metrics.py @@ -16,6 +16,7 @@ class MetricsTypedDict(TypedDict): checkouts: NotRequired[Nullable[MetricTypedDict]] succeeded_checkouts: NotRequired[Nullable[MetricTypedDict]] churned_subscriptions: NotRequired[Nullable[MetricTypedDict]] + churn_rate: NotRequired[Nullable[MetricTypedDict]] orders: NotRequired[Nullable[MetricTypedDict]] revenue: NotRequired[Nullable[MetricTypedDict]] net_revenue: NotRequired[Nullable[MetricTypedDict]] @@ -46,7 +47,6 @@ class MetricsTypedDict(TypedDict): canceled_subscriptions_unused: NotRequired[Nullable[MetricTypedDict]] canceled_subscriptions_other: NotRequired[Nullable[MetricTypedDict]] checkouts_conversion: NotRequired[Nullable[MetricTypedDict]] - churn_rate: NotRequired[Nullable[MetricTypedDict]] ltv: NotRequired[Nullable[MetricTypedDict]] gross_margin: NotRequired[Nullable[MetricTypedDict]] gross_margin_percentage: NotRequired[Nullable[MetricTypedDict]] @@ -70,6 +70,8 @@ class Metrics(BaseModel): churned_subscriptions: OptionalNullable[Metric] = UNSET + churn_rate: OptionalNullable[Metric] = UNSET + orders: OptionalNullable[Metric] = UNSET revenue: OptionalNullable[Metric] = UNSET @@ -130,8 +132,6 @@ class Metrics(BaseModel): checkouts_conversion: OptionalNullable[Metric] = UNSET - churn_rate: OptionalNullable[Metric] = UNSET - ltv: OptionalNullable[Metric] = UNSET gross_margin: OptionalNullable[Metric] = UNSET @@ -151,6 +151,7 @@ def serialize_model(self, handler): "checkouts", "succeeded_checkouts", "churned_subscriptions", + "churn_rate", "orders", "revenue", "net_revenue", @@ -181,7 +182,6 @@ def serialize_model(self, handler): "canceled_subscriptions_unused", "canceled_subscriptions_other", "checkouts_conversion", - "churn_rate", "ltv", "gross_margin", "gross_margin_percentage", @@ -196,6 +196,7 @@ def serialize_model(self, handler): "checkouts", "succeeded_checkouts", "churned_subscriptions", + "churn_rate", "orders", "revenue", "net_revenue", @@ -226,7 +227,6 @@ def serialize_model(self, handler): "canceled_subscriptions_unused", "canceled_subscriptions_other", "checkouts_conversion", - "churn_rate", "ltv", "gross_margin", "gross_margin_percentage", diff --git a/src/polar_sdk/models/metricstotals.py b/src/polar_sdk/models/metricstotals.py index b6640007..0b0a8b41 100644 --- a/src/polar_sdk/models/metricstotals.py +++ b/src/polar_sdk/models/metricstotals.py @@ -85,6 +85,14 @@ ) +MetricsTotalsChurnRateTypedDict = TypeAliasType( + "MetricsTotalsChurnRateTypedDict", Union[int, float] +) + + +MetricsTotalsChurnRate = TypeAliasType("MetricsTotalsChurnRate", Union[int, float]) + + MetricsTotalsOrdersTypedDict = TypeAliasType( "MetricsTotalsOrdersTypedDict", Union[int, float] ) @@ -375,14 +383,6 @@ ) -MetricsTotalsChurnRateTypedDict = TypeAliasType( - "MetricsTotalsChurnRateTypedDict", Union[int, float] -) - - -MetricsTotalsChurnRate = TypeAliasType("MetricsTotalsChurnRate", Union[int, float]) - - MetricsTotalsLtvTypedDict = TypeAliasType( "MetricsTotalsLtvTypedDict", Union[int, float] ) @@ -438,6 +438,7 @@ class MetricsTotalsTypedDict(TypedDict): churned_subscriptions: NotRequired[ Nullable[MetricsTotalsChurnedSubscriptionsTypedDict] ] + churn_rate: NotRequired[Nullable[MetricsTotalsChurnRateTypedDict]] orders: NotRequired[Nullable[MetricsTotalsOrdersTypedDict]] revenue: NotRequired[Nullable[MetricsTotalsRevenueTypedDict]] net_revenue: NotRequired[Nullable[MetricsTotalsNetRevenueTypedDict]] @@ -506,7 +507,6 @@ class MetricsTotalsTypedDict(TypedDict): checkouts_conversion: NotRequired[ Nullable[MetricsTotalsCheckoutsConversionTypedDict] ] - churn_rate: NotRequired[Nullable[MetricsTotalsChurnRateTypedDict]] ltv: NotRequired[Nullable[MetricsTotalsLtvTypedDict]] gross_margin: NotRequired[Nullable[MetricsTotalsGrossMarginTypedDict]] gross_margin_percentage: NotRequired[ @@ -540,6 +540,8 @@ class MetricsTotals(BaseModel): churned_subscriptions: OptionalNullable[MetricsTotalsChurnedSubscriptions] = UNSET + churn_rate: OptionalNullable[MetricsTotalsChurnRate] = UNSET + orders: OptionalNullable[MetricsTotalsOrders] = UNSET revenue: OptionalNullable[MetricsTotalsRevenue] = UNSET @@ -628,8 +630,6 @@ class MetricsTotals(BaseModel): checkouts_conversion: OptionalNullable[MetricsTotalsCheckoutsConversion] = UNSET - churn_rate: OptionalNullable[MetricsTotalsChurnRate] = UNSET - ltv: OptionalNullable[MetricsTotalsLtv] = UNSET gross_margin: OptionalNullable[MetricsTotalsGrossMargin] = UNSET @@ -651,6 +651,7 @@ def serialize_model(self, handler): "checkouts", "succeeded_checkouts", "churned_subscriptions", + "churn_rate", "orders", "revenue", "net_revenue", @@ -681,7 +682,6 @@ def serialize_model(self, handler): "canceled_subscriptions_unused", "canceled_subscriptions_other", "checkouts_conversion", - "churn_rate", "ltv", "gross_margin", "gross_margin_percentage", @@ -696,6 +696,7 @@ def serialize_model(self, handler): "checkouts", "succeeded_checkouts", "churned_subscriptions", + "churn_rate", "orders", "revenue", "net_revenue", @@ -726,7 +727,6 @@ def serialize_model(self, handler): "canceled_subscriptions_unused", "canceled_subscriptions_other", "checkouts_conversion", - "churn_rate", "ltv", "gross_margin", "gross_margin_percentage", diff --git a/src/polar_sdk/models/organization.py b/src/polar_sdk/models/organization.py index e698ac33..939d488f 100644 --- a/src/polar_sdk/models/organization.py +++ b/src/polar_sdk/models/organization.py @@ -27,11 +27,265 @@ OrganizationSubscriptionSettingsTypedDict, ) from .subscriptionprorationbehavior import SubscriptionProrationBehavior +from .taxbehavioroption import TaxBehaviorOption from datetime import datetime -from polar_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from enum import Enum +from polar_sdk.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL from pydantic import model_serializer from typing import List -from typing_extensions import TypedDict +from typing_extensions import NotRequired, TypedDict + + +class CountryAlpha2(str, Enum): + AD = "AD" + AE = "AE" + AF = "AF" + AG = "AG" + AI = "AI" + AL = "AL" + AM = "AM" + AO = "AO" + AQ = "AQ" + AR = "AR" + AS = "AS" + AT = "AT" + AU = "AU" + AW = "AW" + AX = "AX" + AZ = "AZ" + BA = "BA" + BB = "BB" + BD = "BD" + BE = "BE" + BF = "BF" + BG = "BG" + BH = "BH" + BI = "BI" + BJ = "BJ" + BL = "BL" + BM = "BM" + BN = "BN" + BO = "BO" + BQ = "BQ" + BR = "BR" + BS = "BS" + BT = "BT" + BV = "BV" + BW = "BW" + BY = "BY" + BZ = "BZ" + CA = "CA" + CC = "CC" + CD = "CD" + CF = "CF" + CG = "CG" + CH = "CH" + CI = "CI" + CK = "CK" + CL = "CL" + CM = "CM" + CN = "CN" + CO = "CO" + CR = "CR" + CU = "CU" + CV = "CV" + CW = "CW" + CX = "CX" + CY = "CY" + CZ = "CZ" + DE = "DE" + DJ = "DJ" + DK = "DK" + DM = "DM" + DO = "DO" + DZ = "DZ" + EC = "EC" + EE = "EE" + EG = "EG" + EH = "EH" + ER = "ER" + ES = "ES" + ET = "ET" + FI = "FI" + FJ = "FJ" + FK = "FK" + FM = "FM" + FO = "FO" + FR = "FR" + GA = "GA" + GB = "GB" + GD = "GD" + GE = "GE" + GF = "GF" + GG = "GG" + GH = "GH" + GI = "GI" + GL = "GL" + GM = "GM" + GN = "GN" + GP = "GP" + GQ = "GQ" + GR = "GR" + GS = "GS" + GT = "GT" + GU = "GU" + GW = "GW" + GY = "GY" + HK = "HK" + HM = "HM" + HN = "HN" + HR = "HR" + HT = "HT" + HU = "HU" + ID = "ID" + IE = "IE" + IL = "IL" + IM = "IM" + IN = "IN" + IO = "IO" + IQ = "IQ" + IR = "IR" + IS = "IS" + IT = "IT" + JE = "JE" + JM = "JM" + JO = "JO" + JP = "JP" + KE = "KE" + KG = "KG" + KH = "KH" + KI = "KI" + KM = "KM" + KN = "KN" + KP = "KP" + KR = "KR" + KW = "KW" + KY = "KY" + KZ = "KZ" + LA = "LA" + LB = "LB" + LC = "LC" + LI = "LI" + LK = "LK" + LR = "LR" + LS = "LS" + LT = "LT" + LU = "LU" + LV = "LV" + LY = "LY" + MA = "MA" + MC = "MC" + MD = "MD" + ME = "ME" + MF = "MF" + MG = "MG" + MH = "MH" + MK = "MK" + ML = "ML" + MM = "MM" + MN = "MN" + MO = "MO" + MP = "MP" + MQ = "MQ" + MR = "MR" + MS = "MS" + MT = "MT" + MU = "MU" + MV = "MV" + MW = "MW" + MX = "MX" + MY = "MY" + MZ = "MZ" + NA = "NA" + NC = "NC" + NE = "NE" + NF = "NF" + NG = "NG" + NI = "NI" + NL = "NL" + NO = "NO" + NP = "NP" + NR = "NR" + NU = "NU" + NZ = "NZ" + OM = "OM" + PA = "PA" + PE = "PE" + PF = "PF" + PG = "PG" + PH = "PH" + PK = "PK" + PL = "PL" + PM = "PM" + PN = "PN" + PR = "PR" + PS = "PS" + PT = "PT" + PW = "PW" + PY = "PY" + QA = "QA" + RE = "RE" + RO = "RO" + RS = "RS" + RU = "RU" + RW = "RW" + SA = "SA" + SB = "SB" + SC = "SC" + SD = "SD" + SE = "SE" + SG = "SG" + SH = "SH" + SI = "SI" + SJ = "SJ" + SK = "SK" + SL = "SL" + SM = "SM" + SN = "SN" + SO = "SO" + SR = "SR" + SS = "SS" + ST = "ST" + SV = "SV" + SX = "SX" + SY = "SY" + SZ = "SZ" + TC = "TC" + TD = "TD" + TF = "TF" + TG = "TG" + TH = "TH" + TJ = "TJ" + TK = "TK" + TL = "TL" + TM = "TM" + TN = "TN" + TO = "TO" + TR = "TR" + TT = "TT" + TV = "TV" + TW = "TW" + TZ = "TZ" + UA = "UA" + UG = "UG" + UM = "UM" + US = "US" + UY = "UY" + UZ = "UZ" + VA = "VA" + VC = "VC" + VE = "VE" + VG = "VG" + VI = "VI" + VN = "VN" + VU = "VU" + WF = "WF" + WS = "WS" + YE = "YE" + YT = "YT" + ZA = "ZA" + ZM = "ZM" + ZW = "ZW" class OrganizationTypedDict(TypedDict): @@ -58,15 +312,18 @@ class OrganizationTypedDict(TypedDict): r"""Links to social profiles.""" status: OrganizationStatus details_submitted_at: Nullable[datetime] - r"""When the business details were submitted.""" + r"""When the business details were submitted for review.""" default_presentment_currency: str r"""Default presentment currency. Used as fallback in checkout and customer portal, if the customer's local currency is not available.""" + default_tax_behavior: TaxBehaviorOption feature_settings: Nullable[OrganizationFeatureSettingsTypedDict] r"""Organization feature settings""" subscription_settings: OrganizationSubscriptionSettingsTypedDict notification_settings: OrganizationNotificationSettingsTypedDict customer_email_settings: OrganizationCustomerEmailSettingsTypedDict customer_portal_settings: OrganizationCustomerPortalSettingsTypedDict + country: NotRequired[Nullable[CountryAlpha2]] + r"""Two-letter country code (ISO 3166-1 alpha-2).""" class Organization(BaseModel): @@ -105,11 +362,13 @@ class Organization(BaseModel): status: OrganizationStatus details_submitted_at: Nullable[datetime] - r"""When the business details were submitted.""" + r"""When the business details were submitted for review.""" default_presentment_currency: str r"""Default presentment currency. Used as fallback in checkout and customer portal, if the customer's local currency is not available.""" + default_tax_behavior: TaxBehaviorOption + feature_settings: Nullable[OrganizationFeatureSettings] r"""Organization feature settings""" @@ -121,9 +380,12 @@ class Organization(BaseModel): customer_portal_settings: OrganizationCustomerPortalSettings + country: OptionalNullable[CountryAlpha2] = UNSET + r"""Two-letter country code (ISO 3166-1 alpha-2).""" + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["country"] nullable_fields = [ "modified_at", "avatar_url", @@ -131,6 +393,7 @@ def serialize_model(self, handler): "website", "details_submitted_at", "feature_settings", + "country", ] null_default_fields = [] diff --git a/src/polar_sdk/models/organizationcompanylegalentityschema.py b/src/polar_sdk/models/organizationcompanylegalentityschema.py new file mode 100644 index 00000000..e16c4d46 --- /dev/null +++ b/src/polar_sdk/models/organizationcompanylegalentityschema.py @@ -0,0 +1,23 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from polar_sdk.types import BaseModel +from polar_sdk.utils import validate_const +import pydantic +from pydantic.functional_validators import AfterValidator +from typing import Literal +from typing_extensions import Annotated, TypedDict + + +class OrganizationCompanyLegalEntitySchemaTypedDict(TypedDict): + registered_name: str + type: Literal["company"] + + +class OrganizationCompanyLegalEntitySchema(BaseModel): + registered_name: str + + TYPE: Annotated[ + Annotated[Literal["company"], AfterValidator(validate_const("company"))], + pydantic.Field(alias="type"), + ] = "company" diff --git a/src/polar_sdk/models/organizationcreate.py b/src/polar_sdk/models/organizationcreate.py index b712e8b9..5923bce7 100644 --- a/src/polar_sdk/models/organizationcreate.py +++ b/src/polar_sdk/models/organizationcreate.py @@ -1,6 +1,10 @@ """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" from __future__ import annotations +from .organizationcompanylegalentityschema import ( + OrganizationCompanyLegalEntitySchema, + OrganizationCompanyLegalEntitySchemaTypedDict, +) from .organizationcustomeremailsettings import ( OrganizationCustomerEmailSettings, OrganizationCustomerEmailSettingsTypedDict, @@ -14,6 +18,10 @@ OrganizationFeatureSettings, OrganizationFeatureSettingsTypedDict, ) +from .organizationindividuallegalentityschema import ( + OrganizationIndividualLegalEntitySchema, + OrganizationIndividualLegalEntitySchemaTypedDict, +) from .organizationnotificationsettings import ( OrganizationNotificationSettings, OrganizationNotificationSettingsTypedDict, @@ -27,16 +35,285 @@ OrganizationSubscriptionSettingsTypedDict, ) from .presentmentcurrency import PresentmentCurrency +from .taxbehavioroption import TaxBehaviorOption +from enum import Enum from polar_sdk.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL -from pydantic import model_serializer -from typing import List, Optional -from typing_extensions import NotRequired, TypedDict +from polar_sdk.utils import get_discriminator +from pydantic import Discriminator, Tag, model_serializer +from typing import List, Optional, Union +from typing_extensions import Annotated, NotRequired, TypeAliasType, TypedDict + + +LegalEntityTypedDict = TypeAliasType( + "LegalEntityTypedDict", + Union[ + OrganizationIndividualLegalEntitySchemaTypedDict, + OrganizationCompanyLegalEntitySchemaTypedDict, + ], +) + + +LegalEntity = Annotated[ + Union[ + Annotated[OrganizationCompanyLegalEntitySchema, Tag("company")], + Annotated[OrganizationIndividualLegalEntitySchema, Tag("individual")], + ], + Discriminator(lambda m: get_discriminator(m, "type", "type")), +] + + +class CountryAlpha2Input(str, Enum): + AD = "AD" + AE = "AE" + AF = "AF" + AG = "AG" + AI = "AI" + AL = "AL" + AM = "AM" + AO = "AO" + AQ = "AQ" + AR = "AR" + AS = "AS" + AT = "AT" + AU = "AU" + AW = "AW" + AX = "AX" + AZ = "AZ" + BA = "BA" + BB = "BB" + BD = "BD" + BE = "BE" + BF = "BF" + BG = "BG" + BH = "BH" + BI = "BI" + BJ = "BJ" + BL = "BL" + BM = "BM" + BN = "BN" + BO = "BO" + BQ = "BQ" + BR = "BR" + BS = "BS" + BT = "BT" + BV = "BV" + BW = "BW" + BY = "BY" + BZ = "BZ" + CA = "CA" + CC = "CC" + CD = "CD" + CF = "CF" + CG = "CG" + CH = "CH" + CI = "CI" + CK = "CK" + CL = "CL" + CM = "CM" + CN = "CN" + CO = "CO" + CR = "CR" + CV = "CV" + CW = "CW" + CX = "CX" + CY = "CY" + CZ = "CZ" + DE = "DE" + DJ = "DJ" + DK = "DK" + DM = "DM" + DO = "DO" + DZ = "DZ" + EC = "EC" + EE = "EE" + EG = "EG" + EH = "EH" + ER = "ER" + ES = "ES" + ET = "ET" + FI = "FI" + FJ = "FJ" + FK = "FK" + FM = "FM" + FO = "FO" + FR = "FR" + GA = "GA" + GB = "GB" + GD = "GD" + GE = "GE" + GF = "GF" + GG = "GG" + GH = "GH" + GI = "GI" + GL = "GL" + GM = "GM" + GN = "GN" + GP = "GP" + GQ = "GQ" + GR = "GR" + GS = "GS" + GT = "GT" + GU = "GU" + GW = "GW" + GY = "GY" + HK = "HK" + HM = "HM" + HN = "HN" + HR = "HR" + HT = "HT" + HU = "HU" + ID = "ID" + IE = "IE" + IL = "IL" + IM = "IM" + IN = "IN" + IO = "IO" + IQ = "IQ" + IS = "IS" + IT = "IT" + JE = "JE" + JM = "JM" + JO = "JO" + JP = "JP" + KE = "KE" + KG = "KG" + KH = "KH" + KI = "KI" + KM = "KM" + KN = "KN" + KR = "KR" + KW = "KW" + KY = "KY" + KZ = "KZ" + LA = "LA" + LB = "LB" + LC = "LC" + LI = "LI" + LK = "LK" + LR = "LR" + LS = "LS" + LT = "LT" + LU = "LU" + LV = "LV" + LY = "LY" + MA = "MA" + MC = "MC" + MD = "MD" + ME = "ME" + MF = "MF" + MG = "MG" + MH = "MH" + MK = "MK" + ML = "ML" + MM = "MM" + MN = "MN" + MO = "MO" + MP = "MP" + MQ = "MQ" + MR = "MR" + MS = "MS" + MT = "MT" + MU = "MU" + MV = "MV" + MW = "MW" + MX = "MX" + MY = "MY" + MZ = "MZ" + NA = "NA" + NC = "NC" + NE = "NE" + NF = "NF" + NG = "NG" + NI = "NI" + NL = "NL" + NO = "NO" + NP = "NP" + NR = "NR" + NU = "NU" + NZ = "NZ" + OM = "OM" + PA = "PA" + PE = "PE" + PF = "PF" + PG = "PG" + PH = "PH" + PK = "PK" + PL = "PL" + PM = "PM" + PN = "PN" + PR = "PR" + PS = "PS" + PT = "PT" + PW = "PW" + PY = "PY" + QA = "QA" + RE = "RE" + RO = "RO" + RS = "RS" + RW = "RW" + SA = "SA" + SB = "SB" + SC = "SC" + SD = "SD" + SE = "SE" + SG = "SG" + SH = "SH" + SI = "SI" + SJ = "SJ" + SK = "SK" + SL = "SL" + SM = "SM" + SN = "SN" + SO = "SO" + SR = "SR" + SS = "SS" + ST = "ST" + SV = "SV" + SX = "SX" + SZ = "SZ" + TC = "TC" + TD = "TD" + TF = "TF" + TG = "TG" + TH = "TH" + TJ = "TJ" + TK = "TK" + TL = "TL" + TM = "TM" + TN = "TN" + TO = "TO" + TR = "TR" + TT = "TT" + TV = "TV" + TW = "TW" + TZ = "TZ" + UA = "UA" + UG = "UG" + UM = "UM" + US = "US" + UY = "UY" + UZ = "UZ" + VA = "VA" + VC = "VC" + VE = "VE" + VG = "VG" + VI = "VI" + VN = "VN" + VU = "VU" + WF = "WF" + WS = "WS" + YE = "YE" + YT = "YT" + ZA = "ZA" + ZM = "ZM" + ZW = "ZW" class OrganizationCreateTypedDict(TypedDict): name: str slug: str avatar_url: NotRequired[Nullable[str]] + legal_entity: NotRequired[Nullable[LegalEntityTypedDict]] email: NotRequired[Nullable[str]] r"""Public support email.""" website: NotRequired[Nullable[str]] @@ -45,6 +322,8 @@ class OrganizationCreateTypedDict(TypedDict): r"""Link to social profiles.""" details: NotRequired[Nullable[OrganizationDetailsTypedDict]] r"""Additional, private, business details Polar needs about active organizations for compliance (KYC).""" + country: NotRequired[Nullable[CountryAlpha2Input]] + r"""Two-letter country code (ISO 3166-1 alpha-2).""" feature_settings: NotRequired[Nullable[OrganizationFeatureSettingsTypedDict]] subscription_settings: NotRequired[ Nullable[OrganizationSubscriptionSettingsTypedDict] @@ -59,6 +338,7 @@ class OrganizationCreateTypedDict(TypedDict): Nullable[OrganizationCustomerPortalSettingsTypedDict] ] default_presentment_currency: NotRequired[PresentmentCurrency] + default_tax_behavior: NotRequired[TaxBehaviorOption] class OrganizationCreate(BaseModel): @@ -68,6 +348,8 @@ class OrganizationCreate(BaseModel): avatar_url: OptionalNullable[str] = UNSET + legal_entity: OptionalNullable[LegalEntity] = UNSET + email: OptionalNullable[str] = UNSET r"""Public support email.""" @@ -80,6 +362,9 @@ class OrganizationCreate(BaseModel): details: OptionalNullable[OrganizationDetails] = UNSET r"""Additional, private, business details Polar needs about active organizations for compliance (KYC).""" + country: OptionalNullable[CountryAlpha2Input] = UNSET + r"""Two-letter country code (ISO 3166-1 alpha-2).""" + feature_settings: OptionalNullable[OrganizationFeatureSettings] = UNSET subscription_settings: OptionalNullable[OrganizationSubscriptionSettings] = UNSET @@ -94,27 +379,34 @@ class OrganizationCreate(BaseModel): default_presentment_currency: Optional[PresentmentCurrency] = None + default_tax_behavior: Optional[TaxBehaviorOption] = None + @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ "avatar_url", + "legal_entity", "email", "website", "socials", "details", + "country", "feature_settings", "subscription_settings", "notification_settings", "customer_email_settings", "customer_portal_settings", "default_presentment_currency", + "default_tax_behavior", ] nullable_fields = [ "avatar_url", + "legal_entity", "email", "website", "socials", "details", + "country", "feature_settings", "subscription_settings", "notification_settings", diff --git a/src/polar_sdk/models/organizationcustomeremailsettings.py b/src/polar_sdk/models/organizationcustomeremailsettings.py index 752f0021..fb89f582 100644 --- a/src/polar_sdk/models/organizationcustomeremailsettings.py +++ b/src/polar_sdk/models/organizationcustomeremailsettings.py @@ -12,7 +12,9 @@ class OrganizationCustomerEmailSettingsTypedDict(TypedDict): subscription_cycled: bool subscription_cycled_after_trial: bool subscription_past_due: bool + subscription_renewal_reminder: bool subscription_revoked: bool + subscription_trial_conversion_reminder: bool subscription_uncanceled: bool subscription_updated: bool @@ -30,8 +32,12 @@ class OrganizationCustomerEmailSettings(BaseModel): subscription_past_due: bool + subscription_renewal_reminder: bool + subscription_revoked: bool + subscription_trial_conversion_reminder: bool + subscription_uncanceled: bool subscription_updated: bool diff --git a/src/polar_sdk/models/organizationdetails.py b/src/polar_sdk/models/organizationdetails.py index 28cf5487..11350a8d 100644 --- a/src/polar_sdk/models/organizationdetails.py +++ b/src/polar_sdk/models/organizationdetails.py @@ -3,9 +3,10 @@ from __future__ import annotations from enum import Enum from polar_sdk.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL +import pydantic from pydantic import model_serializer from typing import List, Optional -from typing_extensions import NotRequired, TypedDict +from typing_extensions import Annotated, NotRequired, TypedDict class SwitchingFrom(str, Enum): @@ -17,53 +18,106 @@ class SwitchingFrom(str, Enum): class OrganizationDetailsTypedDict(TypedDict): - about: str + about: NotRequired[Nullable[str]] r"""Brief information about you and your business.""" - product_description: str + product_description: NotRequired[Nullable[str]] r"""Description of digital products being sold.""" - intended_use: str + selling_categories: NotRequired[List[str]] + r"""Categories of products being sold.""" + pricing_models: NotRequired[List[str]] + r"""Pricing models used by the organization.""" + intended_use: NotRequired[Nullable[str]] r"""How the organization will integrate and use Polar.""" - customer_acquisition: List[str] + customer_acquisition: NotRequired[List[str]] r"""Main customer acquisition channels.""" - future_annual_revenue: int + future_annual_revenue: NotRequired[Nullable[int]] r"""Estimated revenue in the next 12 months""" switching: NotRequired[bool] r"""Switching from another platform?""" switching_from: NotRequired[Nullable[SwitchingFrom]] r"""Which platform the organization is migrating from.""" - previous_annual_revenue: NotRequired[int] + previous_annual_revenue: NotRequired[Nullable[int]] r"""Revenue from last year if applicable.""" class OrganizationDetails(BaseModel): - about: str + about: Annotated[ + OptionalNullable[str], + pydantic.Field( + deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible." + ), + ] = UNSET r"""Brief information about you and your business.""" - product_description: str + product_description: OptionalNullable[str] = UNSET r"""Description of digital products being sold.""" - intended_use: str + selling_categories: Optional[List[str]] = None + r"""Categories of products being sold.""" + + pricing_models: Optional[List[str]] = None + r"""Pricing models used by the organization.""" + + intended_use: Annotated[ + OptionalNullable[str], + pydantic.Field( + deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible." + ), + ] = UNSET r"""How the organization will integrate and use Polar.""" - customer_acquisition: List[str] + customer_acquisition: Annotated[ + Optional[List[str]], + pydantic.Field( + deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible." + ), + ] = None r"""Main customer acquisition channels.""" - future_annual_revenue: int + future_annual_revenue: Annotated[ + OptionalNullable[int], + pydantic.Field( + deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible." + ), + ] = UNSET r"""Estimated revenue in the next 12 months""" - switching: Optional[bool] = True + switching: Optional[bool] = False r"""Switching from another platform?""" switching_from: OptionalNullable[SwitchingFrom] = UNSET r"""Which platform the organization is migrating from.""" - previous_annual_revenue: Optional[int] = 0 + previous_annual_revenue: Annotated[ + OptionalNullable[int], + pydantic.Field( + deprecated="warning: ** DEPRECATED ** - This will be removed in a future release, please migrate away from it as soon as possible." + ), + ] = UNSET r"""Revenue from last year if applicable.""" @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["switching", "switching_from", "previous_annual_revenue"] - nullable_fields = ["switching_from"] + optional_fields = [ + "about", + "product_description", + "selling_categories", + "pricing_models", + "intended_use", + "customer_acquisition", + "future_annual_revenue", + "switching", + "switching_from", + "previous_annual_revenue", + ] + nullable_fields = [ + "about", + "product_description", + "intended_use", + "future_annual_revenue", + "switching_from", + "previous_annual_revenue", + ] null_default_fields = [] serialized = handler(self) diff --git a/src/polar_sdk/models/organizationindividuallegalentityschema.py b/src/polar_sdk/models/organizationindividuallegalentityschema.py new file mode 100644 index 00000000..11ef2398 --- /dev/null +++ b/src/polar_sdk/models/organizationindividuallegalentityschema.py @@ -0,0 +1,20 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from polar_sdk.types import BaseModel +from polar_sdk.utils import validate_const +import pydantic +from pydantic.functional_validators import AfterValidator +from typing import Literal +from typing_extensions import Annotated, TypedDict + + +class OrganizationIndividualLegalEntitySchemaTypedDict(TypedDict): + type: Literal["individual"] + + +class OrganizationIndividualLegalEntitySchema(BaseModel): + TYPE: Annotated[ + Annotated[Literal["individual"], AfterValidator(validate_const("individual"))], + pydantic.Field(alias="type"), + ] = "individual" diff --git a/src/polar_sdk/models/organizationupdate.py b/src/polar_sdk/models/organizationupdate.py index 626ae04c..4a03175e 100644 --- a/src/polar_sdk/models/organizationupdate.py +++ b/src/polar_sdk/models/organizationupdate.py @@ -27,12 +27,261 @@ OrganizationSubscriptionSettingsTypedDict, ) from .presentmentcurrency import PresentmentCurrency +from .taxbehavioroption import TaxBehaviorOption +from enum import Enum from polar_sdk.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL from pydantic import model_serializer from typing import List from typing_extensions import NotRequired, TypedDict +class CountryCountryAlpha2Input(str, Enum): + AD = "AD" + AE = "AE" + AF = "AF" + AG = "AG" + AI = "AI" + AL = "AL" + AM = "AM" + AO = "AO" + AQ = "AQ" + AR = "AR" + AS = "AS" + AT = "AT" + AU = "AU" + AW = "AW" + AX = "AX" + AZ = "AZ" + BA = "BA" + BB = "BB" + BD = "BD" + BE = "BE" + BF = "BF" + BG = "BG" + BH = "BH" + BI = "BI" + BJ = "BJ" + BL = "BL" + BM = "BM" + BN = "BN" + BO = "BO" + BQ = "BQ" + BR = "BR" + BS = "BS" + BT = "BT" + BV = "BV" + BW = "BW" + BY = "BY" + BZ = "BZ" + CA = "CA" + CC = "CC" + CD = "CD" + CF = "CF" + CG = "CG" + CH = "CH" + CI = "CI" + CK = "CK" + CL = "CL" + CM = "CM" + CN = "CN" + CO = "CO" + CR = "CR" + CV = "CV" + CW = "CW" + CX = "CX" + CY = "CY" + CZ = "CZ" + DE = "DE" + DJ = "DJ" + DK = "DK" + DM = "DM" + DO = "DO" + DZ = "DZ" + EC = "EC" + EE = "EE" + EG = "EG" + EH = "EH" + ER = "ER" + ES = "ES" + ET = "ET" + FI = "FI" + FJ = "FJ" + FK = "FK" + FM = "FM" + FO = "FO" + FR = "FR" + GA = "GA" + GB = "GB" + GD = "GD" + GE = "GE" + GF = "GF" + GG = "GG" + GH = "GH" + GI = "GI" + GL = "GL" + GM = "GM" + GN = "GN" + GP = "GP" + GQ = "GQ" + GR = "GR" + GS = "GS" + GT = "GT" + GU = "GU" + GW = "GW" + GY = "GY" + HK = "HK" + HM = "HM" + HN = "HN" + HR = "HR" + HT = "HT" + HU = "HU" + ID = "ID" + IE = "IE" + IL = "IL" + IM = "IM" + IN = "IN" + IO = "IO" + IQ = "IQ" + IS = "IS" + IT = "IT" + JE = "JE" + JM = "JM" + JO = "JO" + JP = "JP" + KE = "KE" + KG = "KG" + KH = "KH" + KI = "KI" + KM = "KM" + KN = "KN" + KR = "KR" + KW = "KW" + KY = "KY" + KZ = "KZ" + LA = "LA" + LB = "LB" + LC = "LC" + LI = "LI" + LK = "LK" + LR = "LR" + LS = "LS" + LT = "LT" + LU = "LU" + LV = "LV" + LY = "LY" + MA = "MA" + MC = "MC" + MD = "MD" + ME = "ME" + MF = "MF" + MG = "MG" + MH = "MH" + MK = "MK" + ML = "ML" + MM = "MM" + MN = "MN" + MO = "MO" + MP = "MP" + MQ = "MQ" + MR = "MR" + MS = "MS" + MT = "MT" + MU = "MU" + MV = "MV" + MW = "MW" + MX = "MX" + MY = "MY" + MZ = "MZ" + NA = "NA" + NC = "NC" + NE = "NE" + NF = "NF" + NG = "NG" + NI = "NI" + NL = "NL" + NO = "NO" + NP = "NP" + NR = "NR" + NU = "NU" + NZ = "NZ" + OM = "OM" + PA = "PA" + PE = "PE" + PF = "PF" + PG = "PG" + PH = "PH" + PK = "PK" + PL = "PL" + PM = "PM" + PN = "PN" + PR = "PR" + PS = "PS" + PT = "PT" + PW = "PW" + PY = "PY" + QA = "QA" + RE = "RE" + RO = "RO" + RS = "RS" + RW = "RW" + SA = "SA" + SB = "SB" + SC = "SC" + SD = "SD" + SE = "SE" + SG = "SG" + SH = "SH" + SI = "SI" + SJ = "SJ" + SK = "SK" + SL = "SL" + SM = "SM" + SN = "SN" + SO = "SO" + SR = "SR" + SS = "SS" + ST = "ST" + SV = "SV" + SX = "SX" + SZ = "SZ" + TC = "TC" + TD = "TD" + TF = "TF" + TG = "TG" + TH = "TH" + TJ = "TJ" + TK = "TK" + TL = "TL" + TM = "TM" + TN = "TN" + TO = "TO" + TR = "TR" + TT = "TT" + TV = "TV" + TW = "TW" + TZ = "TZ" + UA = "UA" + UG = "UG" + UM = "UM" + US = "US" + UY = "UY" + UZ = "UZ" + VA = "VA" + VC = "VC" + VE = "VE" + VG = "VG" + VI = "VI" + VN = "VN" + VU = "VU" + WF = "WF" + WS = "WS" + YE = "YE" + YT = "YT" + ZA = "ZA" + ZM = "ZM" + ZW = "ZW" + + class OrganizationUpdateTypedDict(TypedDict): name: NotRequired[Nullable[str]] avatar_url: NotRequired[Nullable[str]] @@ -44,6 +293,8 @@ class OrganizationUpdateTypedDict(TypedDict): r"""Links to social profiles.""" details: NotRequired[Nullable[OrganizationDetailsTypedDict]] r"""Additional, private, business details Polar needs about active organizations for compliance (KYC).""" + country: NotRequired[Nullable[CountryCountryAlpha2Input]] + r"""Two-letter country code (ISO 3166-1 alpha-2).""" feature_settings: NotRequired[Nullable[OrganizationFeatureSettingsTypedDict]] subscription_settings: NotRequired[ Nullable[OrganizationSubscriptionSettingsTypedDict] @@ -59,6 +310,8 @@ class OrganizationUpdateTypedDict(TypedDict): ] default_presentment_currency: NotRequired[Nullable[PresentmentCurrency]] r"""Default presentment currency for the organization""" + default_tax_behavior: NotRequired[Nullable[TaxBehaviorOption]] + r"""Default tax behavior applied on products.""" class OrganizationUpdate(BaseModel): @@ -78,6 +331,9 @@ class OrganizationUpdate(BaseModel): details: OptionalNullable[OrganizationDetails] = UNSET r"""Additional, private, business details Polar needs about active organizations for compliance (KYC).""" + country: OptionalNullable[CountryCountryAlpha2Input] = UNSET + r"""Two-letter country code (ISO 3166-1 alpha-2).""" + feature_settings: OptionalNullable[OrganizationFeatureSettings] = UNSET subscription_settings: OptionalNullable[OrganizationSubscriptionSettings] = UNSET @@ -93,6 +349,9 @@ class OrganizationUpdate(BaseModel): default_presentment_currency: OptionalNullable[PresentmentCurrency] = UNSET r"""Default presentment currency for the organization""" + default_tax_behavior: OptionalNullable[TaxBehaviorOption] = UNSET + r"""Default tax behavior applied on products.""" + @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [ @@ -102,12 +361,14 @@ def serialize_model(self, handler): "website", "socials", "details", + "country", "feature_settings", "subscription_settings", "notification_settings", "customer_email_settings", "customer_portal_settings", "default_presentment_currency", + "default_tax_behavior", ] nullable_fields = [ "name", @@ -116,12 +377,14 @@ def serialize_model(self, handler): "website", "socials", "details", + "country", "feature_settings", "subscription_settings", "notification_settings", "customer_email_settings", "customer_portal_settings", "default_presentment_currency", + "default_tax_behavior", ] null_default_fields = [] diff --git a/src/polar_sdk/models/paymentfailed.py b/src/polar_sdk/models/paymentfailed.py new file mode 100644 index 00000000..db65d067 --- /dev/null +++ b/src/polar_sdk/models/paymentfailed.py @@ -0,0 +1,38 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from dataclasses import dataclass, field +import httpx +from polar_sdk.models import PolarError +from polar_sdk.types import BaseModel +from polar_sdk.utils import validate_const +import pydantic +from pydantic.functional_validators import AfterValidator +from typing import Literal, Optional +from typing_extensions import Annotated + + +class PaymentFailedData(BaseModel): + detail: str + + ERROR: Annotated[ + Annotated[ + Literal["PaymentFailed"], AfterValidator(validate_const("PaymentFailed")) + ], + pydantic.Field(alias="error"), + ] = "PaymentFailed" + + +@dataclass(unsafe_hash=True) +class PaymentFailed(PolarError): + data: PaymentFailedData = field(hash=False) + + def __init__( + self, + data: PaymentFailedData, + raw_response: httpx.Response, + body: Optional[str] = None, + ): + message = body or raw_response.text + super().__init__(message, raw_response, body) + object.__setattr__(self, "data", data) diff --git a/src/polar_sdk/models/pendingsubscriptionupdate.py b/src/polar_sdk/models/pendingsubscriptionupdate.py new file mode 100644 index 00000000..525617bd --- /dev/null +++ b/src/polar_sdk/models/pendingsubscriptionupdate.py @@ -0,0 +1,76 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from datetime import datetime +from polar_sdk.types import BaseModel, Nullable, UNSET_SENTINEL +from pydantic import model_serializer +from typing_extensions import TypedDict + + +class PendingSubscriptionUpdateTypedDict(TypedDict): + r"""Pending update to be applied to a subscription at the beginning of the next period.""" + + created_at: datetime + r"""Creation timestamp of the object.""" + modified_at: Nullable[datetime] + r"""Last modification timestamp of the object.""" + id: str + r"""The ID of the object.""" + applies_at: datetime + r"""The date and time when the subscription update will be applied.""" + product_id: Nullable[str] + r"""ID of the new product to apply to the subscription. If `null`, the product won't be changed.""" + seats: Nullable[int] + r"""Number of seats to apply to the subscription. If `null`, the number of seats won't be changed.""" + + +class PendingSubscriptionUpdate(BaseModel): + r"""Pending update to be applied to a subscription at the beginning of the next period.""" + + created_at: datetime + r"""Creation timestamp of the object.""" + + modified_at: Nullable[datetime] + r"""Last modification timestamp of the object.""" + + id: str + r"""The ID of the object.""" + + applies_at: datetime + r"""The date and time when the subscription update will be applied.""" + + product_id: Nullable[str] + r"""ID of the new product to apply to the subscription. If `null`, the product won't be changed.""" + + seats: Nullable[int] + r"""Number of seats to apply to the subscription. If `null`, the number of seats won't be changed.""" + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [] + nullable_fields = ["modified_at", "product_id", "seats"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m diff --git a/src/polar_sdk/models/presentmentcurrency.py b/src/polar_sdk/models/presentmentcurrency.py index a79c4c6d..a4ea7899 100644 --- a/src/polar_sdk/models/presentmentcurrency.py +++ b/src/polar_sdk/models/presentmentcurrency.py @@ -5,13 +5,39 @@ class PresentmentCurrency(str, Enum): + AED = "aed" + ARS = "ars" AUD = "aud" BRL = "brl" CAD = "cad" CHF = "chf" + CLP = "clp" + CNY = "cny" + COP = "cop" + CZK = "czk" + DKK = "dkk" EUR = "eur" - INR = "inr" GBP = "gbp" + HKD = "hkd" + HUF = "huf" + IDR = "idr" + ILS = "ils" + INR = "inr" JPY = "jpy" + KRW = "krw" + MXN = "mxn" + MYR = "myr" + NOK = "nok" + NZD = "nzd" + PEN = "pen" + PHP = "php" + PLN = "pln" + RON = "ron" + SAR = "sar" SEK = "sek" + SGD = "sgd" + THB = "thb" + TRY = "try" + TWD = "twd" USD = "usd" + ZAR = "zar" diff --git a/src/polar_sdk/models/productpricecustom.py b/src/polar_sdk/models/productpricecustom.py index eb67f9f7..5ca7a633 100644 --- a/src/polar_sdk/models/productpricecustom.py +++ b/src/polar_sdk/models/productpricecustom.py @@ -2,6 +2,7 @@ from __future__ import annotations from .productpricesource import ProductPriceSource +from .taxbehavioroption import TaxBehaviorOption from datetime import datetime from polar_sdk.types import BaseModel, Nullable, UNSET_SENTINEL from polar_sdk.utils import validate_const @@ -24,6 +25,8 @@ class ProductPriceCustomTypedDict(TypedDict): source: ProductPriceSource price_currency: str r"""The currency in which the customer will be charged.""" + tax_behavior: Nullable[TaxBehaviorOption] + r"""The tax behavior of the price. If null, it defaults to the organization's default tax behavior.""" is_archived: bool r"""Whether the price is archived and no longer available.""" product_id: str @@ -54,6 +57,9 @@ class ProductPriceCustom(BaseModel): price_currency: str r"""The currency in which the customer will be charged.""" + tax_behavior: Nullable[TaxBehaviorOption] + r"""The tax behavior of the price. If null, it defaults to the organization's default tax behavior.""" + is_archived: bool r"""Whether the price is archived and no longer available.""" @@ -77,7 +83,12 @@ class ProductPriceCustom(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [] - nullable_fields = ["modified_at", "maximum_amount", "preset_amount"] + nullable_fields = [ + "modified_at", + "tax_behavior", + "maximum_amount", + "preset_amount", + ] null_default_fields = [] serialized = handler(self) diff --git a/src/polar_sdk/models/productpricecustomcreate.py b/src/polar_sdk/models/productpricecustomcreate.py index 8e7cde8b..1a6ad145 100644 --- a/src/polar_sdk/models/productpricecustomcreate.py +++ b/src/polar_sdk/models/productpricecustomcreate.py @@ -2,6 +2,7 @@ from __future__ import annotations from .presentmentcurrency import PresentmentCurrency +from .taxbehavioroption import TaxBehaviorOption from polar_sdk.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL from polar_sdk.utils import validate_const import pydantic @@ -16,6 +17,8 @@ class ProductPriceCustomCreateTypedDict(TypedDict): amount_type: Literal["custom"] price_currency: NotRequired[PresentmentCurrency] + tax_behavior: NotRequired[Nullable[TaxBehaviorOption]] + r"""The tax behavior of the price. If not set, it will default to the organization's default tax behavior.""" minimum_amount: NotRequired[int] r"""The minimum amount the customer can pay. If set to 0, the price is 'free or pay what you want' and $0 is accepted. If set to a value between 1-49, it will be rejected. Defaults to 50 cents.""" maximum_amount: NotRequired[Nullable[int]] @@ -34,6 +37,9 @@ class ProductPriceCustomCreate(BaseModel): price_currency: Optional[PresentmentCurrency] = None + tax_behavior: OptionalNullable[TaxBehaviorOption] = UNSET + r"""The tax behavior of the price. If not set, it will default to the organization's default tax behavior.""" + minimum_amount: Optional[int] = 50 r"""The minimum amount the customer can pay. If set to 0, the price is 'free or pay what you want' and $0 is accepted. If set to a value between 1-49, it will be rejected. Defaults to 50 cents.""" @@ -47,11 +53,12 @@ class ProductPriceCustomCreate(BaseModel): def serialize_model(self, handler): optional_fields = [ "price_currency", + "tax_behavior", "minimum_amount", "maximum_amount", "preset_amount", ] - nullable_fields = ["maximum_amount", "preset_amount"] + nullable_fields = ["tax_behavior", "maximum_amount", "preset_amount"] null_default_fields = [] serialized = handler(self) diff --git a/src/polar_sdk/models/productpricefixed.py b/src/polar_sdk/models/productpricefixed.py index b98f4d1b..63834616 100644 --- a/src/polar_sdk/models/productpricefixed.py +++ b/src/polar_sdk/models/productpricefixed.py @@ -2,6 +2,7 @@ from __future__ import annotations from .productpricesource import ProductPriceSource +from .taxbehavioroption import TaxBehaviorOption from datetime import datetime from polar_sdk.types import BaseModel, Nullable, UNSET_SENTINEL from polar_sdk.utils import validate_const @@ -24,6 +25,8 @@ class ProductPriceFixedTypedDict(TypedDict): source: ProductPriceSource price_currency: str r"""The currency in which the customer will be charged.""" + tax_behavior: Nullable[TaxBehaviorOption] + r"""The tax behavior of the price. If null, it defaults to the organization's default tax behavior.""" is_archived: bool r"""Whether the price is archived and no longer available.""" product_id: str @@ -50,6 +53,9 @@ class ProductPriceFixed(BaseModel): price_currency: str r"""The currency in which the customer will be charged.""" + tax_behavior: Nullable[TaxBehaviorOption] + r"""The tax behavior of the price. If null, it defaults to the organization's default tax behavior.""" + is_archived: bool r"""Whether the price is archived and no longer available.""" @@ -67,7 +73,7 @@ class ProductPriceFixed(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [] - nullable_fields = ["modified_at"] + nullable_fields = ["modified_at", "tax_behavior"] null_default_fields = [] serialized = handler(self) diff --git a/src/polar_sdk/models/productpricefixedcreate.py b/src/polar_sdk/models/productpricefixedcreate.py index 8ef91c06..2d97f8b9 100644 --- a/src/polar_sdk/models/productpricefixedcreate.py +++ b/src/polar_sdk/models/productpricefixedcreate.py @@ -2,9 +2,11 @@ from __future__ import annotations from .presentmentcurrency import PresentmentCurrency -from polar_sdk.types import BaseModel +from .taxbehavioroption import TaxBehaviorOption +from polar_sdk.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL from polar_sdk.utils import validate_const import pydantic +from pydantic import model_serializer from pydantic.functional_validators import AfterValidator from typing import Literal, Optional from typing_extensions import Annotated, NotRequired, TypedDict @@ -14,16 +16,84 @@ class ProductPriceFixedCreateTypedDict(TypedDict): r"""Schema to create a fixed price.""" price_amount: int - r"""The price in cents.""" + r"""The price in cents. + Minimum amounts per currency: + - USD: $0.50 + - AED: AED2.00 + - ARS: ARS0.50 + - AUD: A$0.50 + - BRL: R$0.50 + - CAD: CA$0.50 + - CHF: CHF0.50 + - COP: COP0.50 + - CZK: CZK15.00 + - DKK: DKK2.50 + - EUR: €0.50 + - GBP: £0.30 + - HKD: HK$4.00 + - HUF: HUF175.00 + - IDR: IDR0.50 + - ILS: ₪0.50 + - INR: ₹60.00 + - JPY: ¥50 + - KRW: ₩50 + - MXN: MX$0.10 + - MYR: MYR2.00 + - NOK: NOK3.00 + - NZD: NZ$0.50 + - PHP: ₱0.50 + - PLN: PLN2.00 + - RON: RON2.00 + - RUB: RUB0.50 + - SEK: SEK3.00 + - SGD: SGD0.50 + - THB: THB0.10 + - ZAR: ZAR0.50 + """ amount_type: Literal["fixed"] price_currency: NotRequired[PresentmentCurrency] + tax_behavior: NotRequired[Nullable[TaxBehaviorOption]] + r"""The tax behavior of the price. If not set, it will default to the organization's default tax behavior.""" class ProductPriceFixedCreate(BaseModel): r"""Schema to create a fixed price.""" price_amount: int - r"""The price in cents.""" + r"""The price in cents. + Minimum amounts per currency: + - USD: $0.50 + - AED: AED2.00 + - ARS: ARS0.50 + - AUD: A$0.50 + - BRL: R$0.50 + - CAD: CA$0.50 + - CHF: CHF0.50 + - COP: COP0.50 + - CZK: CZK15.00 + - DKK: DKK2.50 + - EUR: €0.50 + - GBP: £0.30 + - HKD: HK$4.00 + - HUF: HUF175.00 + - IDR: IDR0.50 + - ILS: ₪0.50 + - INR: ₹60.00 + - JPY: ¥50 + - KRW: ₩50 + - MXN: MX$0.10 + - MYR: MYR2.00 + - NOK: NOK3.00 + - NZD: NZ$0.50 + - PHP: ₱0.50 + - PLN: PLN2.00 + - RON: RON2.00 + - RUB: RUB0.50 + - SEK: SEK3.00 + - SGD: SGD0.50 + - THB: THB0.10 + - ZAR: ZAR0.50 + """ AMOUNT_TYPE: Annotated[ Annotated[Literal["fixed"], AfterValidator(validate_const("fixed"))], @@ -31,3 +101,36 @@ class ProductPriceFixedCreate(BaseModel): ] = "fixed" price_currency: Optional[PresentmentCurrency] = None + + tax_behavior: OptionalNullable[TaxBehaviorOption] = UNSET + r"""The tax behavior of the price. If not set, it will default to the organization's default tax behavior.""" + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = ["price_currency", "tax_behavior"] + nullable_fields = ["tax_behavior"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m diff --git a/src/polar_sdk/models/productpricefree.py b/src/polar_sdk/models/productpricefree.py index 0b8b6396..d52c2f1d 100644 --- a/src/polar_sdk/models/productpricefree.py +++ b/src/polar_sdk/models/productpricefree.py @@ -2,6 +2,7 @@ from __future__ import annotations from .productpricesource import ProductPriceSource +from .taxbehavioroption import TaxBehaviorOption from datetime import datetime from polar_sdk.types import BaseModel, Nullable, UNSET_SENTINEL from polar_sdk.utils import validate_const @@ -24,6 +25,8 @@ class ProductPriceFreeTypedDict(TypedDict): source: ProductPriceSource price_currency: str r"""The currency in which the customer will be charged.""" + tax_behavior: Nullable[TaxBehaviorOption] + r"""The tax behavior of the price. If null, it defaults to the organization's default tax behavior.""" is_archived: bool r"""Whether the price is archived and no longer available.""" product_id: str @@ -48,6 +51,9 @@ class ProductPriceFree(BaseModel): price_currency: str r"""The currency in which the customer will be charged.""" + tax_behavior: Nullable[TaxBehaviorOption] + r"""The tax behavior of the price. If null, it defaults to the organization's default tax behavior.""" + is_archived: bool r"""Whether the price is archived and no longer available.""" @@ -62,7 +68,7 @@ class ProductPriceFree(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [] - nullable_fields = ["modified_at"] + nullable_fields = ["modified_at", "tax_behavior"] null_default_fields = [] serialized = handler(self) diff --git a/src/polar_sdk/models/productpricefreecreate.py b/src/polar_sdk/models/productpricefreecreate.py index 4cc1253c..4c85afd1 100644 --- a/src/polar_sdk/models/productpricefreecreate.py +++ b/src/polar_sdk/models/productpricefreecreate.py @@ -2,9 +2,11 @@ from __future__ import annotations from .presentmentcurrency import PresentmentCurrency -from polar_sdk.types import BaseModel +from .taxbehavioroption import TaxBehaviorOption +from polar_sdk.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL from polar_sdk.utils import validate_const import pydantic +from pydantic import model_serializer from pydantic.functional_validators import AfterValidator from typing import Literal, Optional from typing_extensions import Annotated, NotRequired, TypedDict @@ -15,6 +17,8 @@ class ProductPriceFreeCreateTypedDict(TypedDict): amount_type: Literal["free"] price_currency: NotRequired[PresentmentCurrency] + tax_behavior: NotRequired[Nullable[TaxBehaviorOption]] + r"""The tax behavior of the price. If not set, it will default to the organization's default tax behavior.""" class ProductPriceFreeCreate(BaseModel): @@ -26,3 +30,36 @@ class ProductPriceFreeCreate(BaseModel): ] = "free" price_currency: Optional[PresentmentCurrency] = None + + tax_behavior: OptionalNullable[TaxBehaviorOption] = UNSET + r"""The tax behavior of the price. If not set, it will default to the organization's default tax behavior.""" + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = ["price_currency", "tax_behavior"] + nullable_fields = ["tax_behavior"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m diff --git a/src/polar_sdk/models/productpricemeteredunit.py b/src/polar_sdk/models/productpricemeteredunit.py index 18773144..29195d67 100644 --- a/src/polar_sdk/models/productpricemeteredunit.py +++ b/src/polar_sdk/models/productpricemeteredunit.py @@ -3,6 +3,7 @@ from __future__ import annotations from .productpricemeter import ProductPriceMeter, ProductPriceMeterTypedDict from .productpricesource import ProductPriceSource +from .taxbehavioroption import TaxBehaviorOption from datetime import datetime from polar_sdk.types import BaseModel, Nullable, UNSET_SENTINEL from polar_sdk.utils import validate_const @@ -25,6 +26,8 @@ class ProductPriceMeteredUnitTypedDict(TypedDict): source: ProductPriceSource price_currency: str r"""The currency in which the customer will be charged.""" + tax_behavior: Nullable[TaxBehaviorOption] + r"""The tax behavior of the price. If null, it defaults to the organization's default tax behavior.""" is_archived: bool r"""Whether the price is archived and no longer available.""" product_id: str @@ -57,6 +60,9 @@ class ProductPriceMeteredUnit(BaseModel): price_currency: str r"""The currency in which the customer will be charged.""" + tax_behavior: Nullable[TaxBehaviorOption] + r"""The tax behavior of the price. If null, it defaults to the organization's default tax behavior.""" + is_archived: bool r"""Whether the price is archived and no longer available.""" @@ -85,7 +91,7 @@ class ProductPriceMeteredUnit(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [] - nullable_fields = ["modified_at", "cap_amount"] + nullable_fields = ["modified_at", "tax_behavior", "cap_amount"] null_default_fields = [] serialized = handler(self) diff --git a/src/polar_sdk/models/productpricemeteredunitcreate.py b/src/polar_sdk/models/productpricemeteredunitcreate.py index 8ad2d15d..dbddca26 100644 --- a/src/polar_sdk/models/productpricemeteredunitcreate.py +++ b/src/polar_sdk/models/productpricemeteredunitcreate.py @@ -2,6 +2,7 @@ from __future__ import annotations from .presentmentcurrency import PresentmentCurrency +from .taxbehavioroption import TaxBehaviorOption from polar_sdk.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL from polar_sdk.utils import validate_const import pydantic @@ -28,6 +29,8 @@ class ProductPriceMeteredUnitCreateTypedDict(TypedDict): r"""The price per unit in cents. Supports up to 12 decimal places.""" amount_type: Literal["metered_unit"] price_currency: NotRequired[PresentmentCurrency] + tax_behavior: NotRequired[Nullable[TaxBehaviorOption]] + r"""The tax behavior of the price. If not set, it will default to the organization's default tax behavior.""" cap_amount: NotRequired[Nullable[int]] r"""Optional maximum amount in cents that can be charged, regardless of the number of units consumed.""" @@ -50,13 +53,16 @@ class ProductPriceMeteredUnitCreate(BaseModel): price_currency: Optional[PresentmentCurrency] = None + tax_behavior: OptionalNullable[TaxBehaviorOption] = UNSET + r"""The tax behavior of the price. If not set, it will default to the organization's default tax behavior.""" + cap_amount: OptionalNullable[int] = UNSET r"""Optional maximum amount in cents that can be charged, regardless of the number of units consumed.""" @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = ["price_currency", "cap_amount"] - nullable_fields = ["cap_amount"] + optional_fields = ["price_currency", "tax_behavior", "cap_amount"] + nullable_fields = ["tax_behavior", "cap_amount"] null_default_fields = [] serialized = handler(self) diff --git a/src/polar_sdk/models/productpriceseatbased.py b/src/polar_sdk/models/productpriceseatbased.py index 366d579c..ff323588 100644 --- a/src/polar_sdk/models/productpriceseatbased.py +++ b/src/polar_sdk/models/productpriceseatbased.py @@ -6,6 +6,7 @@ ProductPriceSeatTiersOutputTypedDict, ) from .productpricesource import ProductPriceSource +from .taxbehavioroption import TaxBehaviorOption from datetime import datetime from polar_sdk.types import BaseModel, Nullable, UNSET_SENTINEL from polar_sdk.utils import validate_const @@ -28,6 +29,8 @@ class ProductPriceSeatBasedTypedDict(TypedDict): source: ProductPriceSource price_currency: str r"""The currency in which the customer will be charged.""" + tax_behavior: Nullable[TaxBehaviorOption] + r"""The tax behavior of the price. If null, it defaults to the organization's default tax behavior.""" is_archived: bool r"""Whether the price is archived and no longer available.""" product_id: str @@ -59,6 +62,9 @@ class ProductPriceSeatBased(BaseModel): price_currency: str r"""The currency in which the customer will be charged.""" + tax_behavior: Nullable[TaxBehaviorOption] + r"""The tax behavior of the price. If null, it defaults to the organization's default tax behavior.""" + is_archived: bool r"""Whether the price is archived and no longer available.""" @@ -81,7 +87,7 @@ class ProductPriceSeatBased(BaseModel): @model_serializer(mode="wrap") def serialize_model(self, handler): optional_fields = [] - nullable_fields = ["modified_at"] + nullable_fields = ["modified_at", "tax_behavior"] null_default_fields = [] serialized = handler(self) diff --git a/src/polar_sdk/models/productpriceseatbasedcreate.py b/src/polar_sdk/models/productpriceseatbasedcreate.py index 1df697e4..56124857 100644 --- a/src/polar_sdk/models/productpriceseatbasedcreate.py +++ b/src/polar_sdk/models/productpriceseatbasedcreate.py @@ -6,9 +6,11 @@ ProductPriceSeatTiersInput, ProductPriceSeatTiersInputTypedDict, ) -from polar_sdk.types import BaseModel +from .taxbehavioroption import TaxBehaviorOption +from polar_sdk.types import BaseModel, Nullable, OptionalNullable, UNSET, UNSET_SENTINEL from polar_sdk.utils import validate_const import pydantic +from pydantic import model_serializer from pydantic.functional_validators import AfterValidator from typing import Literal, Optional from typing_extensions import Annotated, NotRequired, TypedDict @@ -26,6 +28,8 @@ class ProductPriceSeatBasedCreateTypedDict(TypedDict): """ amount_type: Literal["seat_based"] price_currency: NotRequired[PresentmentCurrency] + tax_behavior: NotRequired[Nullable[TaxBehaviorOption]] + r"""The tax behavior of the price. If not set, it will default to the organization's default tax behavior.""" class ProductPriceSeatBasedCreate(BaseModel): @@ -45,3 +49,36 @@ class ProductPriceSeatBasedCreate(BaseModel): ] = "seat_based" price_currency: Optional[PresentmentCurrency] = None + + tax_behavior: OptionalNullable[TaxBehaviorOption] = UNSET + r"""The tax behavior of the price. If not set, it will default to the organization's default tax behavior.""" + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = ["price_currency", "tax_behavior"] + nullable_fields = ["tax_behavior"] + null_default_fields = [] + + serialized = handler(self) + + m = {} + + for n, f in type(self).model_fields.items(): + k = f.alias or n + val = serialized.get(k) + serialized.pop(k, None) + + optional_nullable = k in optional_fields and k in nullable_fields + is_set = ( + self.__pydantic_fields_set__.intersection({n}) + or k in null_default_fields + ) # pylint: disable=no-member + + if val is not None and val != UNSET_SENTINEL: + m[k] = val + elif val != UNSET_SENTINEL and ( + not k in optional_fields or (optional_nullable and is_set) + ): + m[k] = val + + return m diff --git a/src/polar_sdk/models/productpriceseattiers_input.py b/src/polar_sdk/models/productpriceseattiers_input.py index 8f85f00c..47b745c9 100644 --- a/src/polar_sdk/models/productpriceseattiers_input.py +++ b/src/polar_sdk/models/productpriceseattiers_input.py @@ -2,9 +2,10 @@ from __future__ import annotations from .productpriceseattier import ProductPriceSeatTier, ProductPriceSeatTierTypedDict +from .seattiertype import SeatTierType from polar_sdk.types import BaseModel -from typing import List -from typing_extensions import TypedDict +from typing import List, Optional +from typing_extensions import NotRequired, TypedDict class ProductPriceSeatTiersInputTypedDict(TypedDict): @@ -17,6 +18,7 @@ class ProductPriceSeatTiersInputTypedDict(TypedDict): tiers: List[ProductPriceSeatTierTypedDict] r"""List of pricing tiers""" + seat_tier_type: NotRequired[SeatTierType] class ProductPriceSeatTiersInput(BaseModel): @@ -29,3 +31,5 @@ class ProductPriceSeatTiersInput(BaseModel): tiers: List[ProductPriceSeatTier] r"""List of pricing tiers""" + + seat_tier_type: Optional[SeatTierType] = None diff --git a/src/polar_sdk/models/productpriceseattiers_output.py b/src/polar_sdk/models/productpriceseattiers_output.py index 41fddcb1..b4662a7b 100644 --- a/src/polar_sdk/models/productpriceseattiers_output.py +++ b/src/polar_sdk/models/productpriceseattiers_output.py @@ -2,10 +2,11 @@ from __future__ import annotations from .productpriceseattier import ProductPriceSeatTier, ProductPriceSeatTierTypedDict +from .seattiertype import SeatTierType from polar_sdk.types import BaseModel, Nullable, UNSET_SENTINEL from pydantic import model_serializer -from typing import List -from typing_extensions import TypedDict +from typing import List, Optional +from typing_extensions import NotRequired, TypedDict class ProductPriceSeatTiersOutputTypedDict(TypedDict): @@ -22,6 +23,7 @@ class ProductPriceSeatTiersOutputTypedDict(TypedDict): r"""Minimum number of seats required for purchase, derived from first tier.""" maximum_seats: Nullable[int] r"""Maximum number of seats allowed for purchase, derived from last tier. None for unlimited.""" + seat_tier_type: NotRequired[SeatTierType] class ProductPriceSeatTiersOutput(BaseModel): @@ -41,9 +43,11 @@ class ProductPriceSeatTiersOutput(BaseModel): maximum_seats: Nullable[int] r"""Maximum number of seats allowed for purchase, derived from last tier. None for unlimited.""" + seat_tier_type: Optional[SeatTierType] = None + @model_serializer(mode="wrap") def serialize_model(self, handler): - optional_fields = [] + optional_fields = ["seat_tier_type"] nullable_fields = ["maximum_seats"] null_default_fields = [] diff --git a/src/polar_sdk/models/seatassign.py b/src/polar_sdk/models/seatassign.py index 2b19b384..9583aec0 100644 --- a/src/polar_sdk/models/seatassign.py +++ b/src/polar_sdk/models/seatassign.py @@ -21,9 +21,9 @@ class SeatAssignTypedDict(TypedDict): customer_id: NotRequired[Nullable[str]] r"""Customer ID for the seat assignment""" external_member_id: NotRequired[Nullable[str]] - r"""External member ID for the seat assignment. Only supported when member_model_enabled is true. Can be used alone (lookup existing member) or with email (create/validate member).""" + r"""External member ID for the seat assignment. Can be used alone (lookup existing member) or with email (create/validate member).""" member_id: NotRequired[Nullable[str]] - r"""Member ID for the seat assignment. Only supported when member_model_enabled is true.""" + r"""Member ID for the seat assignment.""" metadata: NotRequired[Nullable[Dict[str, Any]]] r"""Additional metadata for the seat (max 10 keys, 1KB total)""" immediate_claim: NotRequired[bool] @@ -50,10 +50,10 @@ class SeatAssign(BaseModel): r"""Customer ID for the seat assignment""" external_member_id: OptionalNullable[str] = UNSET - r"""External member ID for the seat assignment. Only supported when member_model_enabled is true. Can be used alone (lookup existing member) or with email (create/validate member).""" + r"""External member ID for the seat assignment. Can be used alone (lookup existing member) or with email (create/validate member).""" member_id: OptionalNullable[str] = UNSET - r"""Member ID for the seat assignment. Only supported when member_model_enabled is true.""" + r"""Member ID for the seat assignment.""" metadata: OptionalNullable[Dict[str, Any]] = UNSET r"""Additional metadata for the seat (max 10 keys, 1KB total)""" diff --git a/src/polar_sdk/models/seattiertype.py b/src/polar_sdk/models/seattiertype.py new file mode 100644 index 00000000..51de6473 --- /dev/null +++ b/src/polar_sdk/models/seattiertype.py @@ -0,0 +1,9 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from enum import Enum + + +class SeatTierType(str, Enum): + VOLUME = "volume" + GRADUATED = "graduated" diff --git a/src/polar_sdk/models/subscription.py b/src/polar_sdk/models/subscription.py index 6b69c6e5..8cb2bb2f 100644 --- a/src/polar_sdk/models/subscription.py +++ b/src/polar_sdk/models/subscription.py @@ -23,6 +23,10 @@ LegacyRecurringProductPriceTypedDict, ) from .metadataoutputtype import MetadataOutputType, MetadataOutputTypeTypedDict +from .pendingsubscriptionupdate import ( + PendingSubscriptionUpdate, + PendingSubscriptionUpdateTypedDict, +) from .product import Product, ProductTypedDict from .productprice import ProductPrice, ProductPriceTypedDict from .subscriptioncustomer import SubscriptionCustomer, SubscriptionCustomerTypedDict @@ -128,6 +132,8 @@ class SubscriptionTypedDict(TypedDict): r"""List of enabled prices for the subscription.""" meters: List[SubscriptionMeterTypedDict] r"""List of meters associated with the subscription.""" + pending_update: Nullable[PendingSubscriptionUpdateTypedDict] + r"""Pending subscription update that will be applied at the beginning of the next period. If `null`, there is no pending update.""" seats: NotRequired[Nullable[int]] r"""The number of seats for seat-based subscriptions. None for non-seat subscriptions.""" custom_field_data: NotRequired[Dict[str, Nullable[CustomFieldDataTypedDict]]] @@ -214,6 +220,9 @@ class Subscription(BaseModel): meters: List[SubscriptionMeter] r"""List of meters associated with the subscription.""" + pending_update: Nullable[PendingSubscriptionUpdate] + r"""Pending subscription update that will be applied at the beginning of the next period. If `null`, there is no pending update.""" + seats: OptionalNullable[int] = UNSET r"""The number of seats for seat-based subscriptions. None for non-seat subscriptions.""" @@ -237,6 +246,7 @@ def serialize_model(self, handler): "customer_cancellation_reason", "customer_cancellation_comment", "discount", + "pending_update", ] null_default_fields = [] diff --git a/src/polar_sdk/models/taxbehavioroption.py b/src/polar_sdk/models/taxbehavioroption.py new file mode 100644 index 00000000..8c1d70d0 --- /dev/null +++ b/src/polar_sdk/models/taxbehavioroption.py @@ -0,0 +1,10 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from enum import Enum + + +class TaxBehaviorOption(str, Enum): + LOCATION = "location" + INCLUSIVE = "inclusive" + EXCLUSIVE = "exclusive" diff --git a/src/polar_sdk/polar_subscriptions.py b/src/polar_sdk/polar_subscriptions.py index 5d2a1fce..f5156ea3 100644 --- a/src/polar_sdk/polar_subscriptions.py +++ b/src/polar_sdk/polar_subscriptions.py @@ -604,13 +604,16 @@ def update( security_source=security, ), request=req, - error_status_codes=["403", "404", "422", "4XX", "5XX"], + error_status_codes=["402", "403", "404", "422", "4XX", "5XX"], retry_config=retry_config, ) response_data: Any = None if utils.match_response(http_res, "200", "application/json"): return unmarshal_json_response(models.CustomerSubscription, http_res) + if utils.match_response(http_res, "402", "application/json"): + response_data = unmarshal_json_response(models.PaymentFailedData, http_res) + raise models.PaymentFailed(response_data, http_res) if utils.match_response(http_res, "403", "application/json"): response_data = unmarshal_json_response( models.AlreadyCanceledSubscriptionData, http_res @@ -723,13 +726,16 @@ async def update_async( security_source=security, ), request=req, - error_status_codes=["403", "404", "422", "4XX", "5XX"], + error_status_codes=["402", "403", "404", "422", "4XX", "5XX"], retry_config=retry_config, ) response_data: Any = None if utils.match_response(http_res, "200", "application/json"): return unmarshal_json_response(models.CustomerSubscription, http_res) + if utils.match_response(http_res, "402", "application/json"): + response_data = unmarshal_json_response(models.PaymentFailedData, http_res) + raise models.PaymentFailed(response_data, http_res) if utils.match_response(http_res, "403", "application/json"): response_data = unmarshal_json_response( models.AlreadyCanceledSubscriptionData, http_res diff --git a/src/polar_sdk/subscriptions.py b/src/polar_sdk/subscriptions.py index 1e78c2ff..a28c13eb 100644 --- a/src/polar_sdk/subscriptions.py +++ b/src/polar_sdk/subscriptions.py @@ -1042,13 +1042,16 @@ def update( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["403", "404", "409", "422", "4XX", "5XX"], + error_status_codes=["402", "403", "404", "409", "422", "4XX", "5XX"], retry_config=retry_config, ) response_data: Any = None if utils.match_response(http_res, "200", "application/json"): return unmarshal_json_response(models.Subscription, http_res) + if utils.match_response(http_res, "402", "application/json"): + response_data = unmarshal_json_response(models.PaymentFailedData, http_res) + raise models.PaymentFailed(response_data, http_res) if utils.match_response(http_res, "403", "application/json"): response_data = unmarshal_json_response( models.AlreadyCanceledSubscriptionData, http_res @@ -1160,13 +1163,16 @@ async def update_async( security_source=self.sdk_configuration.security, ), request=req, - error_status_codes=["403", "404", "409", "422", "4XX", "5XX"], + error_status_codes=["402", "403", "404", "409", "422", "4XX", "5XX"], retry_config=retry_config, ) response_data: Any = None if utils.match_response(http_res, "200", "application/json"): return unmarshal_json_response(models.Subscription, http_res) + if utils.match_response(http_res, "402", "application/json"): + response_data = unmarshal_json_response(models.PaymentFailedData, http_res) + raise models.PaymentFailed(response_data, http_res) if utils.match_response(http_res, "403", "application/json"): response_data = unmarshal_json_response( models.AlreadyCanceledSubscriptionData, http_res From 0146b3ecb6218db47011eb6fb5aeea14837babe9 Mon Sep 17 00:00:00 2001 From: "speakeasy-github[bot]" <128539517+speakeasy-github[bot]@users.noreply.github.com> Date: Thu, 26 Mar 2026 00:27:10 +0000 Subject: [PATCH 2/2] empty commit to trigger [run-tests] workflow