From 269dc2b2deeb1f4e04fbb6a8733025f5bb5c80c9 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 28 Jul 2026 00:32:56 +0000 Subject: [PATCH 1/2] ## Python SDK Changes Detected: * `polar._endpointcheckout_updated_post()`: * `request.data.payment_method_type` **Added** **Breaking** :warning: * `polar.events.get()`: `response.[system_event]` **Changed** **Breaking** :warning: * `polar.events.list()`: `response.[list_resource_event_].items.[].[system_event]` **Changed** **Breaking** :warning: * `polar._endpointcheckout_expired_post()`: * `request.data.payment_method_type` **Added** **Breaking** :warning: * `polar._endpointcheckout_created_post()`: * `request.data.payment_method_type` **Added** **Breaking** :warning: * `polar.checkouts.list()`: `response.items.[].payment_method_type` **Added** * `polar._endpointdiscount_deleted_post()`: **Added** * `polar.webhooks.list_webhook_deliveries()`: `request.event_type` **Changed** * `polar._endpointsubscription_cycled_post()`: **Added** * `polar.checkouts.create()`: `response.payment_method_type` **Added** * `polar.checkouts.get()`: `response.payment_method_type` **Added** * `polar.checkouts.update()`: `response.payment_method_type` **Added** * `polar.checkouts.client_get()`: `response.payment_method_type` **Added** * `polar.checkouts.client_update()`: * `request.checkout_update_public.payment_method_type` **Added** * `response.payment_method_type` **Added** * `polar.checkouts.client_confirm()`: * `request.checkout_confirm_stripe.payment_method_type` **Added** * `response.payment_method_type` **Added** * `polar._endpointdiscount_updated_post()`: **Added** * `polar._endpointdiscount_created_post()`: **Added** --- .speakeasy/gen.lock | 166 +++++++++++++----- .speakeasy/gen.yaml | 2 +- .speakeasy/workflow.lock | 12 +- RELEASES.md | 12 +- codeSamples.yaml | 32 +++- docs/models/checkout.md | 1 + docs/models/checkoutconfirmstripe.md | 1 + docs/models/checkoutpublic.md | 1 + docs/models/checkoutpublicconfirmed.md | 1 + docs/models/checkoutupdatepublic.md | 1 + docs/models/orderunvoidedevent.md | 23 +++ docs/models/orderunvoidedmetadata.md | 10 ++ docs/models/subscriptionreinstatedevent.md | 23 +++ docs/models/subscriptionreinstatedmetadata.md | 13 ++ docs/models/systemevent.md | 12 ++ docs/models/webhookdiscountcreatedpayload.md | 14 ++ docs/models/webhookdiscountdeletedpayload.md | 14 ++ docs/models/webhookdiscountupdatedpayload.md | 14 ++ docs/models/webhookeventtype.md | 4 + .../webhooksubscriptioncycledpayload.md | 22 +++ .../webhooksubscriptionupdatedpayload.md | 2 +- pyproject.toml | 2 +- src/polar_sdk/_version.py | 4 +- src/polar_sdk/models/__init__.py | 61 +++++++ src/polar_sdk/models/checkout.py | 6 + src/polar_sdk/models/checkoutconfirmstripe.py | 7 + src/polar_sdk/models/checkoutpublic.py | 6 + .../models/checkoutpublicconfirmed.py | 6 + src/polar_sdk/models/checkoutupdatepublic.py | 7 + src/polar_sdk/models/orderunvoidedevent.py | 140 +++++++++++++++ src/polar_sdk/models/orderunvoidedmetadata.py | 19 ++ .../models/subscriptionreinstatedevent.py | 144 +++++++++++++++ .../models/subscriptionreinstatedmetadata.py | 29 +++ src/polar_sdk/models/systemevent.py | 9 + .../models/webhookdiscountcreatedpayload.py | 41 +++++ .../models/webhookdiscountdeletedpayload.py | 41 +++++ .../models/webhookdiscountupdatedpayload.py | 41 +++++ src/polar_sdk/models/webhookeventtype.py | 4 + .../webhooksubscriptioncycledpayload.py | 57 ++++++ .../webhooksubscriptionupdatedpayload.py | 4 +- 40 files changed, 949 insertions(+), 59 deletions(-) create mode 100644 docs/models/orderunvoidedevent.md create mode 100644 docs/models/orderunvoidedmetadata.md create mode 100644 docs/models/subscriptionreinstatedevent.md create mode 100644 docs/models/subscriptionreinstatedmetadata.md create mode 100644 docs/models/webhookdiscountcreatedpayload.md create mode 100644 docs/models/webhookdiscountdeletedpayload.md create mode 100644 docs/models/webhookdiscountupdatedpayload.md create mode 100644 docs/models/webhooksubscriptioncycledpayload.md create mode 100644 src/polar_sdk/models/orderunvoidedevent.py create mode 100644 src/polar_sdk/models/orderunvoidedmetadata.py create mode 100644 src/polar_sdk/models/subscriptionreinstatedevent.py create mode 100644 src/polar_sdk/models/subscriptionreinstatedmetadata.py create mode 100644 src/polar_sdk/models/webhookdiscountcreatedpayload.py create mode 100644 src/polar_sdk/models/webhookdiscountdeletedpayload.py create mode 100644 src/polar_sdk/models/webhookdiscountupdatedpayload.py create mode 100644 src/polar_sdk/models/webhooksubscriptioncycledpayload.py diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 56327dc6..d4c75cf5 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: d3f6c3d7be92e9e992cf5eb454a54422 + docChecksum: db125c15fc05c99f5de955e39b7d3aed docVersion: 2026-04 speakeasyVersion: 1.648.0 generationVersion: 2.737.0 - releaseVersion: 0.32.0 - configChecksum: 649bc0d1f320a2697ce9374e785419df + releaseVersion: 0.32.1 + configChecksum: 23ec14e01c12717565936758b3107282 repoURL: https://github.com/polarsource/polar-python.git installationURL: https://github.com/polarsource/polar-python.git published: true @@ -971,6 +971,8 @@ generatedFiles: - docs/models/orderstatus.md - docs/models/ordersubscription.md - docs/models/ordersupdaterequest.md + - docs/models/orderunvoidedevent.md + - docs/models/orderunvoidedmetadata.md - docs/models/orderupdate.md - docs/models/ordervoidedevent.md - docs/models/ordervoidedmetadata.md @@ -1166,6 +1168,8 @@ generatedFiles: - docs/models/subscriptionprorationbehavior.md - docs/models/subscriptionreactivatedevent.md - docs/models/subscriptionreactivatedmetadata.md + - docs/models/subscriptionreinstatedevent.md + - docs/models/subscriptionreinstatedmetadata.md - docs/models/subscriptionresume.md - docs/models/subscriptionresumedevent.md - docs/models/subscriptionresumedmetadata.md @@ -1242,6 +1246,9 @@ generatedFiles: - docs/models/webhookcustomerstatechangedpayload.md - docs/models/webhookcustomerupdatedpayload.md - docs/models/webhookdelivery.md + - docs/models/webhookdiscountcreatedpayload.md + - docs/models/webhookdiscountdeletedpayload.md + - docs/models/webhookdiscountupdatedpayload.md - docs/models/webhookendpoint.md - docs/models/webhookendpointcreate.md - docs/models/webhookendpointupdate.md @@ -1271,6 +1278,7 @@ generatedFiles: - docs/models/webhooksubscriptionactivepayload.md - docs/models/webhooksubscriptioncanceledpayload.md - docs/models/webhooksubscriptioncreatedpayload.md + - docs/models/webhooksubscriptioncycledpayload.md - docs/models/webhooksubscriptionpastduepayload.md - docs/models/webhooksubscriptionpausedpayload.md - docs/models/webhooksubscriptionresumedpayload.md @@ -1930,6 +1938,8 @@ generatedFiles: - src/polar_sdk/models/ordersortproperty.py - src/polar_sdk/models/orderstatus.py - src/polar_sdk/models/ordersubscription.py + - src/polar_sdk/models/orderunvoidedevent.py + - src/polar_sdk/models/orderunvoidedmetadata.py - src/polar_sdk/models/orderupdate.py - src/polar_sdk/models/ordervoidedevent.py - src/polar_sdk/models/ordervoidedmetadata.py @@ -2063,6 +2073,8 @@ generatedFiles: - src/polar_sdk/models/subscriptionprorationbehavior.py - src/polar_sdk/models/subscriptionreactivatedevent.py - src/polar_sdk/models/subscriptionreactivatedmetadata.py + - src/polar_sdk/models/subscriptionreinstatedevent.py + - src/polar_sdk/models/subscriptionreinstatedmetadata.py - src/polar_sdk/models/subscriptionresume.py - src/polar_sdk/models/subscriptionresumedevent.py - src/polar_sdk/models/subscriptionresumedmetadata.py @@ -2125,6 +2137,9 @@ generatedFiles: - src/polar_sdk/models/webhookcustomerstatechangedpayload.py - src/polar_sdk/models/webhookcustomerupdatedpayload.py - src/polar_sdk/models/webhookdelivery.py + - src/polar_sdk/models/webhookdiscountcreatedpayload.py + - src/polar_sdk/models/webhookdiscountdeletedpayload.py + - src/polar_sdk/models/webhookdiscountupdatedpayload.py - src/polar_sdk/models/webhookendpoint.py - src/polar_sdk/models/webhookendpointcreate.py - src/polar_sdk/models/webhookendpointupdate.py @@ -2153,6 +2168,7 @@ generatedFiles: - src/polar_sdk/models/webhooksubscriptionactivepayload.py - src/polar_sdk/models/webhooksubscriptioncanceledpayload.py - src/polar_sdk/models/webhooksubscriptioncreatedpayload.py + - src/polar_sdk/models/webhooksubscriptioncycledpayload.py - src/polar_sdk/models/webhooksubscriptionpastduepayload.py - src/polar_sdk/models/webhooksubscriptionpausedpayload.py - src/polar_sdk/models/webhooksubscriptionresumedpayload.py @@ -2205,7 +2221,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, "tax_behavior": null, "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, "meter_interval": null, "meter_interval_count": 232991, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2026-11-21T15:05:00.505Z", "modified_at": null, "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 631188, "maximum_amount": 929514, "preset_amount": 115799, "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, "meter_interval": "day", "meter_interval_count": 275553, "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-08-07T15:45:51.732Z", "modified_at": "2024-08-10T12:03:58.542Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 421335, "maximum_amount": null, "preset_amount": null, "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, "is_deleted": false, "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, "is_deleted": 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": {}}} + 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, "tax_behavior": null, "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_method_type": null, "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, "meter_interval": null, "meter_interval_count": 232991, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2026-11-21T15:05:00.505Z", "modified_at": null, "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 631188, "maximum_amount": 929514, "preset_amount": 115799, "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, "meter_interval": "day", "meter_interval_count": 275553, "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-08-07T15:45:51.732Z", "modified_at": "2024-08-10T12:03:58.542Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "month", "minimum_amount": 421335, "maximum_amount": null, "preset_amount": null, "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, "is_deleted": false, "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, "is_deleted": 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: "" @@ -2214,7 +2230,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, "tax_behavior": null, "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, "meter_interval": null, "meter_interval_count": 682397, "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": "2026-10-27T17:49:05.784Z", "modified_at": "2026-02-28T06:09:51.100Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "price_amount": 558100}], "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, "is_deleted": 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, "meter_interval": "week", "meter_interval_count": null, "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": "", "unit": "scalar", "custom_label": "", "custom_multiplier": 164230}}, {"created_at": "2025-05-29T09:31:05.865Z", "modified_at": "2024-06-03T08:35:03.062Z", "id": "", "source": "catalog", "amount_type": "seat_based", "price_currency": "", "tax_behavior": null, "is_archived": true, "product_id": "", "seat_tiers": {"tiers": [{"min_seats": 426798, "price_per_seat": 70808}], "minimum_seats": 792281, "maximum_seats": 558565}}], "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, "is_deleted": 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, "meter_interval": "year", "meter_interval_count": 846374, "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2026-01-29T09:14:14.399Z", "modified_at": "2024-09-13T20:51:28.608Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "week", "price_amount": 795829, "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, "is_deleted": 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, "meter_interval": "day", "meter_interval_count": 968723, "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": "2025-11-21T17:30:50.622Z", "modified_at": "2024-03-20T10:42:26.864Z", "id": "", "source": "ad_hoc", "amount_type": "seat_based", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "seat_tiers": {"tiers": [{"min_seats": 426798, "price_per_seat": 70808}], "minimum_seats": 792281, "maximum_seats": 558565}}, {"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, "is_deleted": true, "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": "", "unit": "token", "custom_label": "", "custom_multiplier": 465247}}, "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, "tax_behavior": null, "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_method_type": null, "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, "meter_interval": null, "meter_interval_count": 682397, "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": "2026-10-27T17:49:05.784Z", "modified_at": "2026-02-28T06:09:51.100Z", "id": "", "source": "ad_hoc", "amount_type": "fixed", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "month", "price_amount": 558100, "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, "is_deleted": 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, "meter_interval": "week", "meter_interval_count": null, "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": "", "unit": "scalar", "custom_label": "", "custom_multiplier": 164230}}, {"created_at": "2025-05-29T09:31:05.865Z", "modified_at": "2024-06-03T08:35:03.062Z", "id": "", "source": "catalog", "amount_type": "seat_based", "price_currency": "", "tax_behavior": null, "is_archived": true, "product_id": "", "seat_tiers": {"tiers": [{"min_seats": 426798, "price_per_seat": 70808}], "minimum_seats": 792281, "maximum_seats": 558565}}], "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, "is_deleted": 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, "meter_interval": "year", "meter_interval_count": 846374, "is_recurring": false, "is_archived": false, "organization_id": "", "prices": [{"created_at": "2026-01-29T09:14:14.399Z", "modified_at": "2024-09-13T20:51:28.608Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "week", "price_amount": 795829, "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, "is_deleted": 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, "meter_interval": "day", "meter_interval_count": 968723, "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": "2025-11-21T17:30:50.622Z", "modified_at": "2024-03-20T10:42:26.864Z", "id": "", "source": "ad_hoc", "amount_type": "seat_based", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "seat_tiers": {"tiers": [{"min_seats": 426798, "price_per_seat": 70808}], "minimum_seats": 792281, "maximum_seats": 558565}}, {"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, "is_deleted": true, "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": "", "unit": "token", "custom_label": "", "custom_multiplier": 465247}}, "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: "" @@ -2313,7 +2329,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", "current_meter_period_start": "2024-10-11T10:17:29.274Z", "current_meter_period_end": "2024-12-17T04:45:55.702Z", "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", "pause_at_period_end": false, "paused_at": "2025-10-11T10:49:29.519Z", "resumes_at": "2024-04-08T09:06:19.384Z", "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_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, "meter_interval": null, "meter_interval_count": null, "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, "is_deleted": true, "organization_id": "", "metadata": {}, "visibility": "draft", "properties": {"prefix": "", "expires": {"ttl": 18256, "timeframe": "day"}, "activations": {"limit": 776442, "enable_customer_admin": false}, "limit_usage": 89994}, "visibility_configurable": true}, {"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, "is_deleted": true, "organization_id": "", "metadata": {"key": 331688, "key1": 10869, "key2": true}, "visibility": "private", "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "maintain"}, "visibility_configurable": true}, {"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, "is_deleted": true, "organization_id": "", "metadata": {"key": 331688, "key1": 10869, "key2": true}, "visibility": "public", "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "maintain"}, "visibility_configurable": true}], "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-09-14T15:19:58.463Z", "modified_at": "2025-07-30T05:01:30.550Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "inclusive", "is_archived": true, "product_id": "", "minimum_amount": 514935, "maximum_amount": 277670, "preset_amount": 783985}], "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}}} + 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", "current_meter_period_start": "2024-10-11T10:17:29.274Z", "current_meter_period_end": "2024-12-17T04:45:55.702Z", "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", "pause_at_period_end": false, "paused_at": "2025-10-11T10:49:29.519Z", "resumes_at": "2024-04-08T09:06:19.384Z", "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_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, "meter_interval": null, "meter_interval_count": null, "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, "is_deleted": true, "organization_id": "", "metadata": {}, "visibility": "draft", "properties": {"prefix": "", "expires": {"ttl": 18256, "timeframe": "day"}, "activations": {"limit": 776442, "enable_customer_admin": false}, "limit_usage": 89994}, "visibility_configurable": true}, {"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, "is_deleted": true, "organization_id": "", "metadata": {"key": 331688, "key1": 10869, "key2": true}, "visibility": "private", "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "maintain"}, "visibility_configurable": true}, {"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, "is_deleted": true, "organization_id": "", "metadata": {"key": 331688, "key1": 10869, "key2": true}, "visibility": "public", "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "maintain"}, "visibility_configurable": true}], "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-09-14T15:19:58.463Z", "modified_at": "2025-07-30T05:01:30.550Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "inclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "day", "minimum_amount": 514935, "maximum_amount": 277670, "preset_amount": 783985, "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: "" @@ -2862,7 +2878,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, "tax_behavior": "inclusive", "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, "meter_interval": "week", "meter_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, "is_deleted": true, "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, "meter_interval": "month", "meter_interval_count": 645390, "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, "is_deleted": true, "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, "meter_interval": "year", "meter_interval_count": 951282, "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": "2024-05-29T22:42:00.703Z", "modified_at": "2026-05-05T10:21:47.685Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 241940, "maximum_amount": 733508, "preset_amount": 262775, "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": "", "unit": "scalar", "custom_label": "", "custom_multiplier": null}}], "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, "is_deleted": 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, "is_deleted": 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": "2026-01-04T19:59:21.584Z", "modified_at": "2026-05-29T18:03:23.625Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 439463, "maximum_amount": 287383, "preset_amount": 381287, "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, "tax_behavior": "inclusive", "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_method_type": "", "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, "meter_interval": "week", "meter_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, "is_deleted": true, "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, "meter_interval": "month", "meter_interval_count": 645390, "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, "is_deleted": true, "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, "meter_interval": "year", "meter_interval_count": 951282, "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": "2024-05-29T22:42:00.703Z", "modified_at": "2026-05-05T10:21:47.685Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 241940, "maximum_amount": 733508, "preset_amount": 262775, "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": "", "unit": "scalar", "custom_label": "", "custom_multiplier": null}}], "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, "is_deleted": 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, "is_deleted": 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": "2026-01-04T19:59:21.584Z", "modified_at": "2026-05-29T18:03:23.625Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 439463, "maximum_amount": 287383, "preset_amount": 381287, "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: @@ -2871,7 +2887,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, "tax_behavior": "exclusive", "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, "meter_interval": "year", "meter_interval_count": 324391, "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": "", "unit": "custom", "custom_label": null, "custom_multiplier": 470625}}], "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, "meter_interval": "month", "meter_interval_count": 779234, "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": "", "unit": "custom", "custom_label": "", "custom_multiplier": 12199}}], "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": "2024-10-20T01:12:01.458Z", "modified_at": null, "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 923554, "maximum_amount": 473815, "preset_amount": 299082, "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, "tax_behavior": "exclusive", "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_method_type": "", "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, "meter_interval": "year", "meter_interval_count": 324391, "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": "", "unit": "custom", "custom_label": null, "custom_multiplier": 470625}}], "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, "meter_interval": "month", "meter_interval_count": 779234, "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": "", "unit": "custom", "custom_label": "", "custom_multiplier": 12199}}], "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": "2024-10-20T01:12:01.458Z", "modified_at": null, "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 923554, "maximum_amount": 473815, "preset_amount": 299082, "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: @@ -2881,7 +2897,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, "tax_behavior": "inclusive", "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, "meter_interval": "day", "meter_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, "is_deleted": 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, "is_deleted": 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, "is_deleted": 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, "meter_interval": "day", "meter_interval_count": 387522, "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, "is_deleted": true, "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, "is_deleted": 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, "is_deleted": true, "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, "meter_interval": "month", "meter_interval_count": 427596, "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, "is_deleted": true, "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, "is_deleted": 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, "is_deleted": true, "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, "meter_interval": "month", "meter_interval_count": 435126, "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, "is_deleted": true, "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, "is_deleted": 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, "is_deleted": 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": "", "unit": "token", "custom_label": "", "custom_multiplier": 729244}}, "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, "tax_behavior": "inclusive", "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_method_type": "", "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, "meter_interval": "day", "meter_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, "is_deleted": 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, "is_deleted": 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, "is_deleted": 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, "meter_interval": "day", "meter_interval_count": 387522, "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, "is_deleted": true, "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, "is_deleted": 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, "is_deleted": true, "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, "meter_interval": "month", "meter_interval_count": 427596, "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, "is_deleted": true, "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, "is_deleted": 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, "is_deleted": true, "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, "meter_interval": "month", "meter_interval_count": 435126, "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, "is_deleted": true, "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, "is_deleted": 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, "is_deleted": 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": "", "unit": "token", "custom_label": "", "custom_multiplier": 729244}}, "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": @@ -2895,7 +2911,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, "tax_behavior": "exclusive", "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, "meter_interval": "year", "meter_interval_count": 682201, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2025-12-25T00:35:50.501Z", "modified_at": "2025-09-30T14:39:02.951Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": null, "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "day", "minimum_amount": 108195, "maximum_amount": 854455, "preset_amount": 889166, "legacy": true}, {"created_at": "2026-02-28T02:33:50.620Z", "modified_at": "2024-04-08T13:08:19.870Z", "id": "", "source": "ad_hoc", "amount_type": "seat_based", "price_currency": "", "tax_behavior": null, "is_archived": false, "product_id": "", "seat_tiers": {"tiers": [], "minimum_seats": 97618, "maximum_seats": 780629}}], "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, "is_deleted": 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, "meter_interval": "day", "meter_interval_count": null, "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, "is_deleted": 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, "meter_interval": "day", "meter_interval_count": 767514, "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, "is_deleted": true, "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, "is_deleted": true, "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": "", "unit": "scalar", "custom_label": "", "custom_multiplier": 840966}}, "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, "tax_behavior": "exclusive", "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_method_type": "", "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, "meter_interval": "year", "meter_interval_count": 682201, "is_recurring": true, "is_archived": true, "organization_id": "", "prices": [{"created_at": "2025-12-25T00:35:50.501Z", "modified_at": "2025-09-30T14:39:02.951Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": null, "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "day", "minimum_amount": 108195, "maximum_amount": 854455, "preset_amount": 889166, "legacy": true}, {"created_at": "2026-02-28T02:33:50.620Z", "modified_at": "2024-04-08T13:08:19.870Z", "id": "", "source": "ad_hoc", "amount_type": "seat_based", "price_currency": "", "tax_behavior": null, "is_archived": false, "product_id": "", "seat_tiers": {"tiers": [], "minimum_seats": 97618, "maximum_seats": 780629}}], "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, "is_deleted": 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, "meter_interval": "day", "meter_interval_count": null, "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, "is_deleted": 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, "meter_interval": "day", "meter_interval_count": 767514, "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, "is_deleted": true, "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, "is_deleted": true, "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": "", "unit": "scalar", "custom_label": "", "custom_multiplier": 840966}}, "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": @@ -2909,7 +2925,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, "tax_behavior": "exclusive", "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, "meter_interval": "year", "meter_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, "is_deleted": 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, "meter_interval": "month", "meter_interval_count": 678253, "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, "is_deleted": 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, "meter_interval": "year", "meter_interval_count": 628782, "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": "", "unit": "custom", "custom_label": "", "custom_multiplier": 129651}}, {"created_at": "2024-10-15T01:42:45.699Z", "modified_at": "2026-05-02T20:18:21.996Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 814176, "maximum_amount": 880694, "preset_amount": 679018, "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, "is_deleted": 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": "fixed", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 230020, "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}]} + 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, "tax_behavior": "exclusive", "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_method_type": "", "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, "meter_interval": "year", "meter_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, "is_deleted": 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, "meter_interval": "month", "meter_interval_count": 678253, "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, "is_deleted": 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, "meter_interval": "year", "meter_interval_count": 628782, "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": "", "unit": "custom", "custom_label": "", "custom_multiplier": 129651}}, {"created_at": "2024-10-15T01:42:45.699Z", "modified_at": "2026-05-02T20:18:21.996Z", "id": "", "source": "ad_hoc", "amount_type": "custom", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "minimum_amount": 814176, "maximum_amount": 880694, "preset_amount": 679018, "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, "is_deleted": 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": "fixed", "price_currency": "", "tax_behavior": "exclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 230020, "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": @@ -2925,7 +2941,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, "tax_behavior": null, "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, "meter_interval": null, "meter_interval_count": 192380, "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, "is_deleted": 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, "meter_interval": "week", "meter_interval_count": 568620, "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": "", "unit": "scalar", "custom_label": "", "custom_multiplier": 388726}}], "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, "is_deleted": true, "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, "is_deleted": true, "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}]} + 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, "tax_behavior": null, "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_method_type": null, "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, "meter_interval": null, "meter_interval_count": 192380, "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, "is_deleted": 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, "meter_interval": "week", "meter_interval_count": 568620, "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": "", "unit": "scalar", "custom_label": "", "custom_multiplier": 388726}}], "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, "is_deleted": true, "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, "is_deleted": true, "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": @@ -2943,7 +2959,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, "tax_behavior": "inclusive", "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, "meter_interval": "day", "meter_interval_count": 366642, "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, "is_deleted": 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, "tax_behavior": "inclusive", "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_method_type": "", "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, "meter_interval": "day", "meter_interval_count": 366642, "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, "is_deleted": 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": @@ -4585,7 +4601,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, "tax_behavior": "inclusive", "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, "meter_interval": "day", "meter_interval_count": 511391, "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, "is_deleted": true, "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, "meter_interval": "week", "meter_interval_count": 15552, "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, "is_deleted": 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": {}}} + 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, "tax_behavior": "inclusive", "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_method_type": "", "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, "meter_interval": "day", "meter_interval_count": 511391, "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, "is_deleted": true, "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, "meter_interval": "week", "meter_interval_count": 15552, "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, "is_deleted": 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: "" @@ -4967,7 +4983,43 @@ examples: _endpointsubscription_resumed_post: speakeasy-default-endpointsubscription-resumed-post: requestBody: - application/json: {"type": "subscription.resumed", "timestamp": "2024-01-22T14:24:10.379Z", "data": {"created_at": "2024-06-30T09:29:44.611Z", "modified_at": "2025-05-19T10:15:04.095Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "day", "recurring_interval_count": 910892, "status": "incomplete_expired", "current_period_start": "2026-07-05T11:55:19.948Z", "current_period_end": "2025-10-26T05:39:47.956Z", "current_meter_period_start": null, "current_meter_period_end": "2026-11-24T05:42:14.433Z", "trial_start": "2024-08-16T01:20:56.595Z", "trial_end": "2026-07-09T21:41:25.685Z", "cancel_at_period_end": false, "canceled_at": "2026-03-15T20:24:25.729Z", "started_at": "2024-01-24T07:56:52.664Z", "ends_at": "2025-12-01T07:07:48.564Z", "ended_at": "2026-11-24T20:15:41.291Z", "pause_at_period_end": false, "paused_at": "2026-12-20T07:04:52.345Z", "resumes_at": "2026-02-13T22:06:10.729Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "low_quality", "customer_cancellation_comment": "", "metadata": {"key": ""}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2024-08-10T12:31:29.222Z", "modified_at": "2026-03-05T13:26:09.665Z", "metadata": {}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2025-02-22T23:12:45.988Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2025-01-14T10:56:21.606Z", "modified_at": "2026-01-13T10:49:57.927Z", "trial_interval": "year", "trial_interval_count": 60142, "name": "", "description": "vice proliferate lined doodle", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 285327, "meter_interval": "week", "meter_interval_count": 212696, "is_recurring": true, "is_archived": true, "organization_id": "", "metadata": {}, "prices": [{"created_at": "2025-02-19T06:29:24.413Z", "modified_at": "2025-11-24T11:49:47.599Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "exclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 366168, "legacy": true}], "benefits": [{"id": "", "created_at": "2024-03-08T00:36:46.368Z", "modified_at": null, "type": "github_repository", "description": "except loyalty scale", "selectable": true, "deletable": true, "is_deleted": false, "organization_id": "", "metadata": {}, "visibility": "draft", "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "maintain"}, "visibility_configurable": true}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/tmp", "mime_type": "", "size": 824138, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": "2024-09-11T04:32:32.279Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-28T00:09:11.868Z", "size_readable": "", "public_url": "https://agile-paintwork.net/"}], "attached_custom_fields": []}, "discount": {"duration": "repeating", "type": "fixed", "basis_points": 1000, "created_at": "2024-01-29T12:57:51.159Z", "modified_at": "2026-05-30T05:14:44.253Z", "id": "", "metadata": {"key": 1944.15}, "name": "", "code": "", "starts_at": "2025-05-02T12:20:43.507Z", "ends_at": "2025-11-01T11:32:19.007Z", "max_redemptions": 918147, "redemptions_count": 672454, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [{"created_at": "2024-03-27T18:00:56.006Z", "modified_at": "2025-12-23T19:15:57.393Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "minimum_amount": 399198, "maximum_amount": 429537, "preset_amount": 361115}], "meters": [], "pending_update": {"created_at": "2026-05-21T01:07:20.692Z", "modified_at": "2026-12-12T11:31:51.483Z", "id": "", "applies_at": "2026-08-20T05:33:38.575Z", "product_id": "", "seats": 248287}}} + application/json: {"type": "subscription.resumed", "timestamp": "2024-01-22T14:24:10.379Z", "data": {"created_at": "2024-06-30T09:29:44.611Z", "modified_at": "2025-05-19T10:15:04.095Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "day", "recurring_interval_count": 910892, "status": "incomplete_expired", "current_period_start": "2026-07-05T11:55:19.948Z", "current_period_end": "2025-10-26T05:39:47.956Z", "current_meter_period_start": null, "current_meter_period_end": "2026-11-24T05:42:14.433Z", "trial_start": "2024-08-16T01:20:56.595Z", "trial_end": "2026-07-09T21:41:25.685Z", "cancel_at_period_end": false, "canceled_at": "2026-03-15T20:24:25.729Z", "started_at": "2024-01-24T07:56:52.664Z", "ends_at": "2025-12-01T07:07:48.564Z", "ended_at": "2026-11-24T20:15:41.291Z", "pause_at_period_end": false, "paused_at": "2026-12-20T07:04:52.345Z", "resumes_at": "2026-02-13T22:06:10.729Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "low_quality", "customer_cancellation_comment": "", "metadata": {"key": ""}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2024-08-10T12:31:29.222Z", "modified_at": "2026-03-05T13:26:09.665Z", "metadata": {}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2025-02-22T23:12:45.988Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2025-01-14T10:56:21.606Z", "modified_at": "2026-01-13T10:49:57.927Z", "trial_interval": "year", "trial_interval_count": 60142, "name": "", "description": "vice proliferate lined doodle", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 285327, "meter_interval": "week", "meter_interval_count": 212696, "is_recurring": true, "is_archived": true, "organization_id": "", "metadata": {}, "prices": [{"created_at": "2025-02-19T06:29:24.413Z", "modified_at": "2025-11-24T11:49:47.599Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "exclusive", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "year", "price_amount": 366168, "legacy": true}], "benefits": [{"id": "", "created_at": "2024-03-08T00:36:46.368Z", "modified_at": null, "type": "github_repository", "description": "except loyalty scale", "selectable": true, "deletable": true, "is_deleted": false, "organization_id": "", "metadata": {}, "visibility": "draft", "properties": {"repository_owner": "polarsource", "repository_name": "private_repo", "permission": "maintain"}, "visibility_configurable": true}], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/tmp", "mime_type": "", "size": 824138, "storage_version": "", "checksum_etag": "", "checksum_sha256_base64": null, "checksum_sha256_hex": "", "last_modified_at": "2024-09-11T04:32:32.279Z", "version": "", "service": "product_media", "is_uploaded": false, "created_at": "2025-10-28T00:09:11.868Z", "size_readable": "", "public_url": "https://agile-paintwork.net/"}], "attached_custom_fields": []}, "discount": {"duration": "repeating", "type": "fixed", "basis_points": 1000, "created_at": "2024-01-29T12:57:51.159Z", "modified_at": "2026-05-30T05:14:44.253Z", "id": "", "metadata": {"key": 1944.15}, "name": "", "code": "", "starts_at": "2025-05-02T12:20:43.507Z", "ends_at": "2025-11-01T11:32:19.007Z", "max_redemptions": 918147, "redemptions_count": 672454, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [{"created_at": "2024-03-27T18:00:56.006Z", "modified_at": "2025-12-23T19:15:57.393Z", "id": "", "source": "catalog", "amount_type": "custom", "price_currency": "", "tax_behavior": "location", "is_archived": true, "product_id": "", "type": "recurring", "recurring_interval": "day", "minimum_amount": 399198, "maximum_amount": 429537, "preset_amount": 361115, "legacy": true}], "meters": [], "pending_update": {"created_at": "2026-05-21T01:07:20.692Z", "modified_at": "2026-12-12T11:31:51.483Z", "id": "", "applies_at": "2026-08-20T05:33:38.575Z", "product_id": "", "seats": 248287}}} + responses: + "200": + application/json: "" + "422": + application/json: {} + _endpointsubscription_cycled_post: + speakeasy-default-endpointsubscription-cycled-post: + requestBody: + application/json: {"type": "subscription.cycled", "timestamp": "2024-08-26T09:51:17.561Z", "data": {"created_at": "2024-11-19T00:31:08.557Z", "modified_at": "2024-07-18T16:03:27.425Z", "id": "", "amount": 10000, "currency": "usd", "recurring_interval": "year", "recurring_interval_count": 542449, "status": "trialing", "current_period_start": "2024-11-18T05:58:07.773Z", "current_period_end": "2026-05-27T12:28:57.938Z", "current_meter_period_start": "2026-08-16T20:40:04.980Z", "current_meter_period_end": "2025-02-19T23:53:59.708Z", "trial_start": "2025-09-07T05:40:32.528Z", "trial_end": null, "cancel_at_period_end": true, "canceled_at": "2025-08-17T15:55:05.116Z", "started_at": "2024-09-06T12:23:00.011Z", "ends_at": null, "ended_at": "2024-05-15T10:03:04.868Z", "pause_at_period_end": true, "paused_at": "2024-12-22T00:45:23.828Z", "resumes_at": "2026-06-04T03:28:46.748Z", "customer_id": "", "product_id": "", "discount_id": "", "checkout_id": "", "customer_cancellation_reason": "too_expensive", "customer_cancellation_comment": "", "metadata": {"key": 492829}, "customer": {"id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b", "created_at": "2026-01-12T08:10:57.662Z", "modified_at": "2025-04-02T22:57:12.765Z", "metadata": {"key": ""}, "external_id": "usr_1337", "email": "customer@example.com", "email_verified": true, "type": "individual", "name": "John Doe", "billing_name": "John Doe", "billing_address": {"country": "US"}, "tax_id": ["911144442", "us_ein"], "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "deleted_at": "2025-01-27T06:40:11.845Z", "avatar_url": "https://www.gravatar.com/avatar/xxx?d=404"}, "product": {"id": "", "created_at": "2024-03-31T23:41:50.445Z", "modified_at": "2024-06-03T06:43:58.898Z", "trial_interval": "day", "trial_interval_count": 705527, "name": "", "description": "purple bitterly yearn jovially speedily incidentally given toward meh", "visibility": "private", "recurring_interval": "year", "recurring_interval_count": 28683, "meter_interval": "month", "meter_interval_count": 595551, "is_recurring": false, "is_archived": false, "organization_id": "", "metadata": {}, "prices": [{"created_at": "2026-09-21T11:48:55.499Z", "modified_at": "2026-08-19T04:17:33.887Z", "id": "", "source": "catalog", "amount_type": "fixed", "price_currency": "", "tax_behavior": "inclusive", "is_archived": false, "product_id": "", "type": "recurring", "recurring_interval": "week", "price_amount": 414949, "legacy": true}], "benefits": [], "medias": [{"id": "", "organization_id": "", "name": "", "path": "/tmp", "mime_type": "", "size": 14330, "storage_version": null, "checksum_etag": "", "checksum_sha256_base64": "", "checksum_sha256_hex": "", "last_modified_at": null, "version": "", "service": "product_media", "is_uploaded": true, "created_at": "2026-02-20T12:55:41.520Z", "size_readable": "", "public_url": "https://violent-circumference.com/"}], "attached_custom_fields": [{"custom_field_id": "", "custom_field": {"created_at": "2025-03-28T11:10:45.316Z", "modified_at": null, "id": "", "metadata": {}, "type": "text", "slug": "", "name": "", "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "properties": {}}, "order": 317704, "required": true}]}, "discount": {"duration": "repeating", "duration_in_months": 76891, "type": "fixed", "amount": 1000, "currency": "usd", "amounts": {"eur": 900, "usd": 1000}, "created_at": "2024-05-16T10:26:47.253Z", "modified_at": "2025-08-09T05:00:08.712Z", "id": "", "metadata": {"key": false}, "name": "", "code": "", "starts_at": "2024-02-25T19:10:52.902Z", "ends_at": null, "max_redemptions": 499299, "redemptions_count": 424469, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737"}, "prices": [], "meters": [{"created_at": "2026-04-10T21:57:06.451Z", "modified_at": "2026-11-20T01:13:24.879Z", "id": "", "consumed_units": 25, "credited_units": 100, "amount": 0, "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22", "meter": {"metadata": {}, "created_at": "2025-01-11T17:57:35.970Z", "modified_at": "2025-07-16T11:20:00.879Z", "id": "", "name": "", "unit": "scalar", "filter": {"conjunction": "or", "clauses": [{"conjunction": "and", "clauses": []}]}, "aggregation": {"func": "max", "property": ""}, "organization_id": ""}}], "pending_update": {"created_at": "2026-04-25T12:13:40.453Z", "modified_at": "2025-12-21T21:33:16.851Z", "id": "", "applies_at": "2024-06-01T16:54:56.812Z", "product_id": "", "seats": 74510}}} + responses: + "200": + application/json: "" + "422": + application/json: {} + _endpointdiscount_created_post: + speakeasy-default-endpointdiscount-created-post: + requestBody: + application/json: {"type": "discount.created", "timestamp": "2026-06-01T12:33:29.570Z", "data": {"duration": "repeating", "duration_in_months": 179751, "type": "percentage", "amount": 1000, "currency": "usd", "amounts": {"eur": 900, "usd": 1000}, "created_at": "2024-02-21T05:24:48.689Z", "modified_at": "2026-09-12T01:20:52.031Z", "id": "", "metadata": {"key": ""}, "name": "", "code": "", "starts_at": "2025-02-13T09:12:55.294Z", "ends_at": "2024-10-07T21:58:26.782Z", "max_redemptions": 79512, "redemptions_count": 223951, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "products": []}} + responses: + "200": + application/json: "" + "422": + application/json: {} + _endpointdiscount_updated_post: + speakeasy-default-endpointdiscount-updated-post: + requestBody: + application/json: {"type": "discount.updated", "timestamp": "2025-11-10T23:02:41.327Z", "data": {"duration": "repeating", "type": "fixed", "amount": 1000, "currency": "usd", "amounts": {"eur": 900, "usd": 1000}, "created_at": "2026-06-18T18:53:28.965Z", "modified_at": "2024-09-19T20:57:06.225Z", "id": "", "metadata": {"key": false}, "name": "", "code": "", "starts_at": "2024-07-07T11:25:38.360Z", "ends_at": "2025-10-12T09:13:06.811Z", "max_redemptions": 794318, "redemptions_count": 991313, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "products": [{"metadata": {}, "id": "", "created_at": "2024-01-05T04:00:27.311Z", "modified_at": "2025-10-20T14:01:27.634Z", "trial_interval": "week", "trial_interval_count": null, "name": "", "description": "slipper nor nervously from", "visibility": "draft", "recurring_interval": "year", "recurring_interval_count": 457560, "meter_interval": "month", "meter_interval_count": 475768, "is_recurring": false, "is_archived": false, "organization_id": ""}]}} + responses: + "200": + application/json: "" + "422": + application/json: {} + _endpointdiscount_deleted_post: + speakeasy-default-endpointdiscount-deleted-post: + requestBody: + application/json: {"type": "discount.deleted", "timestamp": "2025-02-20T22:30:40.844Z", "data": {"duration": "repeating", "type": "percentage", "basis_points": 1000, "created_at": "2026-04-12T18:41:55.855Z", "modified_at": "2025-03-02T23:37:37.703Z", "id": "", "metadata": {}, "name": "", "code": "", "starts_at": "2026-03-19T00:46:24.443Z", "ends_at": "2025-12-16T17:40:07.633Z", "max_redemptions": 620156, "redemptions_count": 551200, "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737", "products": []}} responses: "200": application/json: "" @@ -4975,7 +5027,7 @@ examples: application/json: {} examplesVersion: 1.0.2 generatedTests: {} -releaseNotes: "## Python SDK Changes Detected:\n* `polar.orders.export()`: `response.status[200]` **Removed** **Breaking** :warning:\n* `polar.customers.create()`: `response` **Changed** **Breaking** :warning:\n* `polar._endpointcheckout_expired_post()`: \n * `request.data.products.[]` **Changed** **Breaking** :warning:\n* `polar._endpointcustomer_seat_assigned_post()`: \n * `request.data` **Changed** **Breaking** :warning:\n* `polar._endpointcustomer_seat_claimed_post()`: \n * `request.data` **Changed** **Breaking** :warning:\n* `polar.customer_meters.get()`: `response.customer` **Changed** **Breaking** :warning:\n* `polar.customer_meters.list()`: `response.items.[].customer` **Changed** **Breaking** :warning:\n* `polar._endpointcheckout_created_post()`: \n * `request.data.products.[]` **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.customer-sessions.create()`: `response.customer` **Changed** **Breaking** :warning:\n* `polar.customer_portal.subscriptions.update()`: \n * `request.customer_subscription_update` **Changed** **Breaking** :warning:\n * `response` **Changed**\n * `error` **Changed** **Breaking** :warning:\n* `polar.customer_portal.orders.generate_invoice()`: `error` **Changed** **Breaking** :warning:\n* `polar.customer_portal.license_keys.activate()`: `response.license_key.customer.avatar_url` **Changed** **Breaking** :warning:\n* `polar.customer_portal.license_keys.validate()`: `response.customer.avatar_url` **Changed** **Breaking** :warning:\n* `polar.customer_portal.license_keys.get()`: `response.customer.avatar_url` **Changed** **Breaking** :warning:\n* `polar.customer_portal.license_keys.list()`: `response.items.[].customer.avatar_url` **Changed** **Breaking** :warning:\n* `polar.customers.get_state_external()`: `response` **Changed** **Breaking** :warning:\n* `polar.customers.get_state()`: `response` **Changed** **Breaking** :warning:\n* `polar.customers.update_external()`: `response` **Changed** **Breaking** :warning:\n* `polar.customers.get_external()`: `response` **Changed** **Breaking** :warning:\n* `polar.customers.update()`: `response` **Changed** **Breaking** :warning:\n* `polar.customers.get()`: `response` **Changed** **Breaking** :warning:\n* `polar.customers.export()`: `response.status[200]` **Removed** **Breaking** :warning:\n* `polar._endpointcheckout_updated_post()`: \n * `request.data.products.[]` **Changed** **Breaking** :warning:\n* `polar.customers.list()`: `response.items.[]` **Changed** **Breaking** :warning:\n* `polar.license_keys.activate()`: `response.license_key.customer.avatar_url` **Changed** **Breaking** :warning:\n* `polar.license_keys.validate()`: `response.customer.avatar_url` **Changed** **Breaking** :warning:\n* `polar.license_keys.get_activation()`: `response.license_key.customer.avatar_url` **Changed** **Breaking** :warning:\n* `polar._endpointcustomer_seat_revoked_post()`: \n * `request.data` **Changed** **Breaking** :warning:\n* `polar._endpointorder_created_post()`: \n * `request.data` **Changed** **Breaking** :warning:\n* `polar._endpointorder_updated_post()`: \n * `request.data` **Changed** **Breaking** :warning:\n* `polar._endpointorder_paid_post()`: \n * `request.data` **Changed** **Breaking** :warning:\n* `polar._endpointorder_refunded_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._endpointrefund_created_post()`: \n * `request.data.dispute` **Changed** **Breaking** :warning:\n* `polar._endpointrefund_updated_post()`: \n * `request.data.dispute` **Changed** **Breaking** :warning:\n* `polar._endpointproduct_created_post()`: \n * `request.data` **Changed** **Breaking** :warning:\n* `polar._endpointproduct_updated_post()`: \n * `request.data` **Changed** **Breaking** :warning:\n* `polar._endpointorganization_updated_post()`: \n * `request.data` **Changed** **Breaking** :warning:\n* `polar.license_keys.update()`: `response.customer.avatar_url` **Changed** **Breaking** :warning:\n* `polar.license_keys.get()`: `response.customer.avatar_url` **Changed** **Breaking** :warning:\n* `polar.license_keys.list()`: `response.items.[].customer.avatar_url` **Changed** **Breaking** :warning:\n* `polar.metrics.export()`: `response.status[200]` **Removed** **Breaking** :warning:\n* `polar.orders.create()`: `response` **Changed** **Breaking** :warning:\n* `polar.orders.list()`: `response.items.[]` **Changed** **Breaking** :warning:\n* `polar.organizations.list_organizations()`: `response.items.[]` **Changed** **Breaking** :warning:\n* `polar.organizations.create()`: \n * `request` **Changed** **Breaking** :warning:\n * `response` **Changed** **Breaking** :warning:\n * `error.status[403]` **Added**\n* `polar.organizations.get()`: `response` **Changed** **Breaking** :warning:\n* `polar.organizations.update()`: \n * `request.organization_update` **Changed** **Breaking** :warning:\n * `response` **Changed** **Breaking** :warning:\n * `error.status[409]` **Added**\n* `polar.subscriptions.list()`: \n * `request.status` **Changed**\n * `response.items.[]` **Changed** **Breaking** :warning:\n* `polar.subscriptions.create()`: `response` **Changed** **Breaking** :warning:\n* `polar.subscriptions.export()`: `response.status[200]` **Removed** **Breaking** :warning:\n* `polar.subscriptions.get()`: `response` **Changed** **Breaking** :warning:\n* `polar.subscriptions.revoke()`: `response` **Changed** **Breaking** :warning:\n* `polar.subscriptions.update()`: \n * `request.subscription_update` **Changed**\n * `response` **Changed** **Breaking** :warning:\n* `polar.checkouts.create()`: \n * `request.prices.{}.[].[free]` **Removed** **Breaking** :warning:\n * `response.products.[]` **Changed**\n* `polar.orders.generate_invoice()`: `error` **Changed** **Breaking** :warning:\n* `polar.oauth2.clients.delete()`: `response` **Changed** **Breaking** :warning:\n* `polar.benefits.update()`: `request_body` **Changed** **Breaking** :warning:\n* `polar.benefits.grants()`: `response.items.[].customer` **Changed** **Breaking** :warning:\n* `polar.benefit-grants.list()`: `response.items.[].customer` **Changed** **Breaking** :warning:\n* `polar.orders.finalize()`: `response` **Changed** **Breaking** :warning:\n* `polar.orders.update()`: `response` **Changed** **Breaking** :warning:\n* `polar.products.create()`: \n * `request` **Changed** **Breaking** :warning:\n * `response` **Changed**\n* `polar.orders.get()`: `response` **Changed** **Breaking** :warning:\n* `polar.products.update()`: \n * `request.product_update.prices.[].[2].[free]` **Removed** **Breaking** :warning:\n * `response` **Changed**\n* `polar.organization_access_tokens.list()`: **Deleted** **Breaking** :warning:\n* `polar._endpointcustomer_created_post()`: \n * `request.data` **Changed**\n* `polar.files.create()`: \n * `request.[support_case_attachment]` **Added**\n* `polar.disputes.accept()`: **Added**\n* `polar.products.get()`: `response` **Changed**\n* `polar.products.list()`: `response.items.[]` **Changed**\n* `polar.webhooks.list_webhook_deliveries()`: `request.event_type` **Changed**\n* `polar.oauth2.introspect()`: `response.organizations` **Added**\n* `polar.refunds.list()`: `response.items.[].dispute` **Changed**\n* `polar.refunds.create()`: `response.dispute` **Changed**\n* `polar.disputes.list()`: `response.items.[]` **Changed**\n* `polar.disputes.get()`: `response` **Changed**\n* `polar.checkouts.list()`: `response.items.[].products.[]` **Changed**\n* `polar.oauth2.authorize()`: `response` **Changed**\n* `polar._endpointbenefit_grant_revoked_post()`: \n * `request.data.[benefit_grant_discord_webhook].customer` **Changed**\n* `polar.discounts.update()`: `response.[discount_fixed_once_forever_duration].products.[]` **Changed**\n* `polar.checkouts.client_get()`: `response.products.[]` **Changed**\n* `polar.checkouts.client_update()`: `response.products.[]` **Changed**\n* `polar.checkouts.client_confirm()`: `response.products.[]` **Changed**\n* `polar.files.list()`: `response.items.[].[support_case_attachment]` **Added**\n* `polar._endpointbenefit_grant_cycled_post()`: \n * `request.data.[benefit_grant_license_keys_webhook].customer` **Changed**\n* `polar.files.uploaded()`: `response.[support_case_attachment]` **Added**\n* `polar.files.update()`: `response.[support_case_attachment]` **Added**\n* `polar.organization_access_tokens.create()`: **Deleted** **Breaking** :warning:\n* `polar._endpointbenefit_grant_created_post()`: \n * `request.data.[benefit_grant_downloadables_webhook].customer` **Changed**\n* `polar._endpointcustomer_state_changed_post()`: \n * `request.data` **Changed**\n* `polar._endpointcustomer_deleted_post()`: \n * `request.data` **Changed**\n* `polar._endpointcustomer_updated_post()`: \n * `request.data` **Changed**\n* `polar._endpointbenefit_grant_updated_post()`: \n * `request.data.[benefit_grant_discord_webhook].customer` **Changed**\n* `polar.organization_access_tokens.update()`: **Deleted** **Breaking** :warning:\n* `polar.checkout-links.list()`: `response.items.[].products.[]` **Changed**\n* `polar.checkout-links.create()`: `response.products.[]` **Changed**\n* `polar.checkout-links.get()`: `response.products.[]` **Changed**\n* `polar.checkout-links.update()`: `response.products.[]` **Changed**\n* `polar.discounts.list()`: `response.items.[].[discount_fixed_repeat_duration].products.[]` **Changed**\n* `polar.discounts.create()`: `response.[discount_percentage_once_forever_duration].products.[]` **Changed**\n* `polar.discounts.get()`: `response.[discount_fixed_once_forever_duration].products.[]` **Changed**\n* `polar.checkouts.update()`: `response.products.[]` **Changed**\n* `polar.checkouts.get()`: `response.products.[]` **Changed**\n* `polar.products.update_benefits()`: `response` **Changed**\n* `polar.customer_portal.subscriptions.get()`: `response` **Changed**\n* `polar.members.update_member_by_external_id()`: **Deleted** **Breaking** :warning:\n* `polar.members.delete_member_by_external_id()`: **Deleted** **Breaking** :warning:\n* `polar.members.get_member_by_external_id()`: **Deleted** **Breaking** :warning:\n* `polar.members.update_member()`: **Deleted** **Breaking** :warning:\n* `polar.members.delete_member()`: **Deleted** **Breaking** :warning:\n* `polar.members.get_member()`: **Deleted** **Breaking** :warning:\n* `polar.customer_portal.seats.list_seats()`: `response.seats.[]` **Changed**\n* `polar.customer_portal.seats.assign_seat()`: `response` **Changed**\n* `polar.customer_portal.seats.revoke_seat()`: `response` **Changed**\n* `polar.customer_portal.seats.resend_invitation()`: `response` **Changed**\n* `polar.customer_portal.seats.list_claimed_subscriptions()`: `response.items.[]` **Changed**\n* `polar.members.create_member()`: **Deleted** **Breaking** :warning:\n* `polar.customers.members.delete_external()`: **Added**\n* `polar.customers.members.update_external()`: **Added**\n* `polar.customers.members.get_external()`: **Added**\n* `polar.customer_portal.members.update_member()`: \n * `request.customer_portal_member_update.name` **Added**\n* `polar.customer_portal.orders.list()`: `response.items.[]` **Changed**\n* `polar.customer_portal.orders.get()`: `response` **Changed**\n* `polar.customer_portal.orders.update()`: `response` **Changed**\n* `polar.customers.members.delete()`: **Added**\n* `polar.customer_portal.organizations.get()`: `response` **Changed**\n* `polar.customer_portal.subscriptions.list()`: `response.items.[]` **Changed**\n* `polar.organization_access_tokens.delete()`: **Deleted** **Breaking** :warning:\n* `polar.customer_portal.subscriptions.cancel()`: `response` **Changed**\n* `polar.customers.members.update()`: **Added**\n* `polar.customer-seats.list_seats()`: `response.seats.[]` **Changed**\n* `polar.customer-seats.assign_seat()`: `response` **Changed**\n* `polar.customer-seats.revoke_seat()`: `response` **Changed**\n* `polar.customer-seats.resend_invitation()`: `response` **Changed**\n* `polar.customer-seats.claim_seat()`: `response.seat` **Changed**\n* `polar.customers.members.get()`: **Added**\n* `polar.customers.members.create_external()`: **Added**\n* `polar.events.list_names()`: `response.items.[].label` **Added**\n* `polar.customers.members.create()`: **Added**\n* `polar._endpointsubscription_resumed_post()`: **Added**\n* `polar._endpointsubscription_paused_post()`: **Added**\n* `polar.payments.list()`: `response.items.[]` **Changed**\n* `polar.payments.get()`: `response` **Changed**\n" +releaseNotes: "## Python SDK Changes Detected:\n* `polar._endpointcheckout_updated_post()`: \n * `request.data.payment_method_type` **Added** **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._endpointcheckout_expired_post()`: \n * `request.data.payment_method_type` **Added** **Breaking** :warning:\n* `polar._endpointcheckout_created_post()`: \n * `request.data.payment_method_type` **Added** **Breaking** :warning:\n* `polar.checkouts.list()`: `response.items.[].payment_method_type` **Added**\n* `polar._endpointdiscount_deleted_post()`: **Added**\n* `polar.webhooks.list_webhook_deliveries()`: `request.event_type` **Changed**\n* `polar._endpointsubscription_cycled_post()`: **Added**\n* `polar.checkouts.create()`: `response.payment_method_type` **Added**\n* `polar.checkouts.get()`: `response.payment_method_type` **Added**\n* `polar.checkouts.update()`: `response.payment_method_type` **Added**\n* `polar.checkouts.client_get()`: `response.payment_method_type` **Added**\n* `polar.checkouts.client_update()`: \n * `request.checkout_update_public.payment_method_type` **Added**\n * `response.payment_method_type` **Added**\n* `polar.checkouts.client_confirm()`: \n * `request.checkout_confirm_stripe.payment_method_type` **Added**\n * `response.payment_method_type` **Added**\n* `polar._endpointdiscount_updated_post()`: **Added**\n* `polar._endpointdiscount_created_post()`: **Added**\n" trackedFiles: .devcontainer/README.md: last_write_checksum: sha1:e2a191a1fa8ceb27387eb32eabf36f7ad16a532c @@ -5332,11 +5384,11 @@ trackedFiles: docs/models/cashflow.md: last_write_checksum: sha1:1e9738516a979aa16a1dc2121b99d72055fc9abc docs/models/checkout.md: - last_write_checksum: sha1:a228b4ec2d318cedf022822961902dd9cb381e40 + last_write_checksum: sha1:56b87ad6d956438fcd1c6d6ebc612f0794b98cfb docs/models/checkoutbillingaddressfields.md: last_write_checksum: sha1:4f9b44268a23c42b8af95d971f7642138d4542b1 docs/models/checkoutconfirmstripe.md: - last_write_checksum: sha1:a37180dfd8db5b42a63da1290a1f568f05eb0f5e + last_write_checksum: sha1:4b477d1706bd3fe70a8f386c29ce0bded936cf86 docs/models/checkoutconfirmstripecustomfielddata.md: last_write_checksum: sha1:8e5feb192029fd53eabd49eab94326d92b5b03f0 docs/models/checkoutcreate.md: @@ -5422,9 +5474,9 @@ trackedFiles: docs/models/checkoutproductprices.md: last_write_checksum: sha1:3c5bf42bed9d76bd3f78cc17816e4ecd92de3f7d docs/models/checkoutpublic.md: - last_write_checksum: sha1:22bde11c40617211662b903cd99eaea864162673 + last_write_checksum: sha1:fe10ddb17e376f0605df51604966f7f6f442bcda docs/models/checkoutpublicconfirmed.md: - last_write_checksum: sha1:8dea192ab1b5a498f8c223b287691a26b1ecc29b + last_write_checksum: sha1:22706a50aa2cf66bdddb59bf88b5b0a9e4616a10 docs/models/checkoutpublicconfirmedcustomfielddata.md: last_write_checksum: sha1:b4a02ce44bdfe3eb45e9c99b0f1561e41028cdf2 docs/models/checkoutpublicconfirmeddiscount.md: @@ -5482,7 +5534,7 @@ trackedFiles: docs/models/checkoutupdatemetadata.md: last_write_checksum: sha1:9d408b25657a511a3e13f9e5e76b893a7c4a5e03 docs/models/checkoutupdatepublic.md: - last_write_checksum: sha1:4874463685344f02351c34cbcc28aefd428fd174 + last_write_checksum: sha1:c6e8e9565494bbe51820e5b85e97c0e1729d8a2e docs/models/checkoutupdatepubliccustomfielddata.md: last_write_checksum: sha1:8a9915c8ac470d38abaad331803b7568d491854c docs/models/churnedseatcustomers.md: @@ -6837,6 +6889,10 @@ trackedFiles: last_write_checksum: sha1:f6c890b3198aa569311cd81a13d1bbc03679438d docs/models/ordersupdaterequest.md: last_write_checksum: sha1:378b0a113c24421c253510a4533c7e20d4c4fee2 + docs/models/orderunvoidedevent.md: + last_write_checksum: sha1:cd2ed928458e28812000968602a656fbe1b896f1 + docs/models/orderunvoidedmetadata.md: + last_write_checksum: sha1:156c6fc3f3f3b301edc454f8152e380d8bbfce06 docs/models/orderupdate.md: last_write_checksum: sha1:9933b2328bea2295842086aaea9aebf2909be782 docs/models/ordervoidedevent.md: @@ -7227,6 +7283,10 @@ trackedFiles: last_write_checksum: sha1:f1fb6f57c58be2b80e4253b8195a9fec1248db43 docs/models/subscriptionreactivatedmetadata.md: last_write_checksum: sha1:7b2b5827aed162375fca34898ab7f19196e13b5d + docs/models/subscriptionreinstatedevent.md: + last_write_checksum: sha1:31692e758fb2c975c0bb3c70e0b5be1d67d09611 + docs/models/subscriptionreinstatedmetadata.md: + last_write_checksum: sha1:3c6734ee74e9da1ae93192352a37ff44f2e775c0 docs/models/subscriptionresume.md: last_write_checksum: sha1:ec3d6b1346f475e6bef8854c9222e4be0961c5ef docs/models/subscriptionresumedevent.md: @@ -7294,7 +7354,7 @@ trackedFiles: docs/models/switchingfrom.md: last_write_checksum: sha1:242623693cd6649aa665db76babcf7ff2531fd68 docs/models/systemevent.md: - last_write_checksum: sha1:3007ba2cebbd9ac8e572d0b90e1fcee733ef32b5 + last_write_checksum: sha1:bcffa8f542b4609f05866089345da16034a4ede6 docs/models/taxbehavior.md: last_write_checksum: sha1:2873bb04d8399e78cb8faa642913c15e6fa45801 docs/models/taxbehavioroption.md: @@ -7379,6 +7439,12 @@ trackedFiles: last_write_checksum: sha1:d5d56532af0e090a2c1c074f716d4b6b0321fcae docs/models/webhookdelivery.md: last_write_checksum: sha1:ad3347208c254800e88f97b02fdc1aa35ea56fc6 + docs/models/webhookdiscountcreatedpayload.md: + last_write_checksum: sha1:992f85a6de08b5492ede933f26645e54332f1651 + docs/models/webhookdiscountdeletedpayload.md: + last_write_checksum: sha1:a81a27226ede0d63c7e3d90fa83978dd7ab5186d + docs/models/webhookdiscountupdatedpayload.md: + last_write_checksum: sha1:ffdb8007d929414447cbbfcc559993c183ee78d6 docs/models/webhookendpoint.md: last_write_checksum: sha1:e109cc5d7f9e1a9a151041201453a014ea4c3874 docs/models/webhookendpointcreate.md: @@ -7388,7 +7454,7 @@ trackedFiles: docs/models/webhookevent.md: last_write_checksum: sha1:78db9970ae5ed501bea9d03d58ebfff6c9394233 docs/models/webhookeventtype.md: - last_write_checksum: sha1:738b481fb4e4710a675a393bf0497e1e5b92a0e3 + last_write_checksum: sha1:45fa9e20a960a0e1d78b0ca7b22142203f5e0c71 docs/models/webhookformat.md: last_write_checksum: sha1:4709492fbad186b392cca96b341a6c65ea15d8b9 docs/models/webhookmembercreatedpayload.md: @@ -7437,6 +7503,8 @@ trackedFiles: last_write_checksum: sha1:36e15320946db6e209b54bd36a654c9afae9266c docs/models/webhooksubscriptioncreatedpayload.md: last_write_checksum: sha1:8ddd79d1d015dd31bf9df22f6d999d229d520ef2 + docs/models/webhooksubscriptioncycledpayload.md: + last_write_checksum: sha1:ea9f922d15c993d7b28fa9ae3cde654ea69f3e3a docs/models/webhooksubscriptionpastduepayload.md: last_write_checksum: sha1:a014d6a425183c2cc2ec654ae096288c6dc05498 docs/models/webhooksubscriptionpausedpayload.md: @@ -7448,7 +7516,7 @@ trackedFiles: docs/models/webhooksubscriptionuncanceledpayload.md: last_write_checksum: sha1:0fb3f671ef29a23a85676de66d73a5a001ee735d docs/models/webhooksubscriptionupdatedpayload.md: - last_write_checksum: sha1:d411e9a212190e06378253b215c90285ea91a62c + last_write_checksum: sha1:493ed97fb00e095ad70702689c811945dbeb0a81 docs/models/webhooksupdatewebhookendpointrequest.md: last_write_checksum: sha1:b5745fe9f78550f920a802254eeee439bd2fd360 docs/models/webtokenrequest.md: @@ -7458,7 +7526,7 @@ trackedFiles: docs/sdks/benefitgrants/README.md: last_write_checksum: sha1:af83de76c7f0581ee50b139f4ce5423b1fb3b0a9 docs/sdks/benefits/README.md: - last_write_checksum: sha1:af71ea380f50a6f4b669f2c59893ca135580c001 + last_write_checksum: sha1:5d24f9e5c1e67beda95685046c48a1a00b985145 docs/sdks/checkoutlinks/README.md: last_write_checksum: sha1:8e6ba34a40b90e55dc5679a376e80665cebc34f0 docs/sdks/checkouts/README.md: @@ -7542,7 +7610,7 @@ trackedFiles: pylintrc: last_write_checksum: sha1:f3105517b767e704987821cf08b26c09d5235218 pyproject.toml: - last_write_checksum: sha1:8fb5a6b703d1b300723f22075716e3902796fbf0 + last_write_checksum: sha1:6b8aa36a1bdddeebe81b9d0269f7b1ab6c8967a7 scripts/prepare_readme.py: last_write_checksum: sha1:2311639185b318e498a99518d92fa5c847b5c70a scripts/publish.sh: @@ -7556,7 +7624,7 @@ trackedFiles: src/polar_sdk/_hooks/types.py: last_write_checksum: sha1:f0255463ebbcc31cb785aa379e40b09c33ee493b src/polar_sdk/_version.py: - last_write_checksum: sha1:d8f65916bac61c95812fc7771b973998c0a4ea0b + last_write_checksum: sha1:358c93db50d35d405018be39cb2e21878b521537 src/polar_sdk/basesdk.py: last_write_checksum: sha1:4523ea81f1381f171fe2d4e60f85b82203208d02 src/polar_sdk/benefit_grants.py: @@ -7564,7 +7632,7 @@ trackedFiles: src/polar_sdk/benefits.py: last_write_checksum: sha1:54c3f82f8a9923f9c69880a47bcf05e8804ab36f src/polar_sdk/checkout_links.py: - last_write_checksum: sha1:64ecdaf6e7a062890c0cbc8863a8051773c53f40 + last_write_checksum: sha1:b708de83d52c1b6779c4ae0c8a40910395f59f41 src/polar_sdk/checkouts.py: last_write_checksum: sha1:b5dcf2a4cb9824bd7f2cf55fd8b9d0a8bf4a6525 src/polar_sdk/clients.py: @@ -7606,7 +7674,7 @@ trackedFiles: src/polar_sdk/metrics_sdk.py: last_write_checksum: sha1:65d8e1ae450388ba98d6c93901c3ae7e7f3e929e src/polar_sdk/models/__init__.py: - last_write_checksum: sha1:9319d58be391afd94a626c4f5ee2ff4b1e7dacac + last_write_checksum: sha1:ccef2fca4b1cab1f5d3595fbb1a9348eadfa383e src/polar_sdk/models/address.py: last_write_checksum: sha1:083edb7f045174ac1aea30545e9981c33f07d57d src/polar_sdk/models/addressdict.py: @@ -7856,7 +7924,7 @@ trackedFiles: src/polar_sdk/models/cardpaymentmetadata.py: last_write_checksum: sha1:2fe22cf53af2f2fe9b5d9dbd4097c00838cf90d7 src/polar_sdk/models/checkout.py: - last_write_checksum: sha1:34f8434ad0da04f6789c3a4ab29b067d812616a5 + last_write_checksum: sha1:6afc9eabdf35923bd6b9e9c8f6164d1b113044c4 src/polar_sdk/models/checkout_links_deleteop.py: last_write_checksum: sha1:0b6cad5372c170fb1431f4b1a2ed193dba02e9dc src/polar_sdk/models/checkout_links_getop.py: @@ -7868,7 +7936,7 @@ trackedFiles: src/polar_sdk/models/checkoutbillingaddressfields.py: last_write_checksum: sha1:0665454839da8b6c80600bfc3b8bc82782ddc40b src/polar_sdk/models/checkoutconfirmstripe.py: - last_write_checksum: sha1:b365fdd5310a110374dd6d3f7bd86104373da7eb + last_write_checksum: sha1:7a33fd653fd70e26e2ec0484404c8e5cba5f03e6 src/polar_sdk/models/checkoutcreate.py: last_write_checksum: sha1:c446512d921bafa9e98cc25c9920ca1daa4f3273 src/polar_sdk/models/checkoutcreatedevent.py: @@ -7906,9 +7974,9 @@ trackedFiles: src/polar_sdk/models/checkoutproduct.py: last_write_checksum: sha1:5e627a5cf5044c98ed09e9ac4ba90b298d5011b0 src/polar_sdk/models/checkoutpublic.py: - last_write_checksum: sha1:ec413e34e63012a97ab862e60a4247dfb7fe1765 + last_write_checksum: sha1:638355639c388735751afd36c2a288602b2be1a9 src/polar_sdk/models/checkoutpublicconfirmed.py: - last_write_checksum: sha1:29b6f90c8606a5038129a899e80a2a05672f5025 + last_write_checksum: sha1:b3d1239fe36b73bd0f781aa962be364a174e93cd src/polar_sdk/models/checkouts_client_confirmop.py: last_write_checksum: sha1:43b8f70ae5ac54bbbfa26694c917b8b0359cefe5 src/polar_sdk/models/checkouts_client_getop.py: @@ -7928,7 +7996,7 @@ trackedFiles: src/polar_sdk/models/checkoutupdate.py: last_write_checksum: sha1:23867b3bf7df6d2ce2263b1dc6a6b34d1e811622 src/polar_sdk/models/checkoutupdatepublic.py: - last_write_checksum: sha1:ce757370f65805687c159b8e7e94ae1a51d0920b + last_write_checksum: sha1:351d2dcb810c555b386ef08cdd65d96a29ab4ace src/polar_sdk/models/costmetadata_input.py: last_write_checksum: sha1:2ff17a766f114cbb04977f132e58d340dc302d66 src/polar_sdk/models/costmetadata_output.py: @@ -8755,6 +8823,10 @@ trackedFiles: last_write_checksum: sha1:d22b6b744e74c156612aa03b907c16e362de836e src/polar_sdk/models/ordersubscription.py: last_write_checksum: sha1:320495bd594823e6ef5f549c1e982f1402771caa + src/polar_sdk/models/orderunvoidedevent.py: + last_write_checksum: sha1:2b5b73a67d85a7dbd9a5b14d2381eddb280d0714 + src/polar_sdk/models/orderunvoidedmetadata.py: + last_write_checksum: sha1:08ffbcfdd5e8f3fd06fc4576a97a1e1b9ea6631a src/polar_sdk/models/orderupdate.py: last_write_checksum: sha1:89edd80c248803382ab77cfef04497d1d6f4dab1 src/polar_sdk/models/ordervoidedevent.py: @@ -9021,6 +9093,10 @@ trackedFiles: last_write_checksum: sha1:1ca76c933a241105f31db64c3f643b4fc85a5403 src/polar_sdk/models/subscriptionreactivatedmetadata.py: last_write_checksum: sha1:ff6fa132f778882ae37cbd3fe2bda057627f8df9 + src/polar_sdk/models/subscriptionreinstatedevent.py: + last_write_checksum: sha1:d73ba73e7eadd560891b4f5e6858f446550956b7 + src/polar_sdk/models/subscriptionreinstatedmetadata.py: + last_write_checksum: sha1:0755e96f2be400bddad1759c7700a591a1e413ca src/polar_sdk/models/subscriptionresume.py: last_write_checksum: sha1:a942b83b974b13301ed7d24bc683196b169310f9 src/polar_sdk/models/subscriptionresumedevent.py: @@ -9082,7 +9158,7 @@ trackedFiles: src/polar_sdk/models/supportcaseattachmentfileread.py: last_write_checksum: sha1:64399f6fb1748b969d196084584292ef27c2940e src/polar_sdk/models/systemevent.py: - last_write_checksum: sha1:2053203a9630c180bdf52a2a165e3a2ff054bb2f + last_write_checksum: sha1:48d3d0a5f89926740e14f0594a44da4cf6cb2059 src/polar_sdk/models/taxbehavior.py: last_write_checksum: sha1:921ea72d113f192be1b2407a0390e656bb8ee0e0 src/polar_sdk/models/taxbehavioroption.py: @@ -9145,6 +9221,12 @@ trackedFiles: last_write_checksum: sha1:bd2ffacdbc489e79886979c2ed55335e0afba5cb src/polar_sdk/models/webhookdelivery.py: last_write_checksum: sha1:961fb639b9e83c7f4cef0ab634513bc8b51c77c4 + src/polar_sdk/models/webhookdiscountcreatedpayload.py: + last_write_checksum: sha1:25fcad1cc414717d40aaf4c7a292ce1f72c8aa4a + src/polar_sdk/models/webhookdiscountdeletedpayload.py: + last_write_checksum: sha1:6354cb0ab43d85629913faeab1a9965ff453da81 + src/polar_sdk/models/webhookdiscountupdatedpayload.py: + last_write_checksum: sha1:a4468a01d742d34fc7b972fdd32488847d305a74 src/polar_sdk/models/webhookendpoint.py: last_write_checksum: sha1:bca149e75ba9a3b3252580c15ef4e892eb20083b src/polar_sdk/models/webhookendpointcreate.py: @@ -9154,7 +9236,7 @@ trackedFiles: src/polar_sdk/models/webhookevent.py: last_write_checksum: sha1:6a5f95aaffcf13265b6232959c68fd6fcec38e6b src/polar_sdk/models/webhookeventtype.py: - last_write_checksum: sha1:cca15b5c5af9aabda1c0d8e88fe8e729f48ba1bb + last_write_checksum: sha1:bd5f1b0a34fe02f35d27c27b6eefa00140bcb157 src/polar_sdk/models/webhookformat.py: last_write_checksum: sha1:927942f68de60bc6773f031e2f7852216b0e517c src/polar_sdk/models/webhookmembercreatedpayload.py: @@ -9201,6 +9283,8 @@ trackedFiles: last_write_checksum: sha1:1619aa3b72161f6839ea77af78f437751037b92c src/polar_sdk/models/webhooksubscriptioncreatedpayload.py: last_write_checksum: sha1:546e43c4a760cc21c1e786abbda00b9150a19fef + src/polar_sdk/models/webhooksubscriptioncycledpayload.py: + last_write_checksum: sha1:62155065e57a516c414b1298b5b9980771569536 src/polar_sdk/models/webhooksubscriptionpastduepayload.py: last_write_checksum: sha1:87f8de081afdc83847c2e199fe41e047592ac730 src/polar_sdk/models/webhooksubscriptionpausedpayload.py: @@ -9212,13 +9296,13 @@ trackedFiles: src/polar_sdk/models/webhooksubscriptionuncanceledpayload.py: last_write_checksum: sha1:d1c6a5b915ca7c2217a657fd2c94f9b63ca40549 src/polar_sdk/models/webhooksubscriptionupdatedpayload.py: - last_write_checksum: sha1:250d9905f637640d0244fe7f1603568c8e0e1995 + last_write_checksum: sha1:70efb8e8ac5c57d5d2b8691013a2392c91e778c9 src/polar_sdk/models/webtokenrequest.py: last_write_checksum: sha1:353ea7941fcbe8978da439858c204851b13d27af src/polar_sdk/oauth2.py: last_write_checksum: sha1:6740f1146c4087ac23c4e93cb17fcaa70a8f53d0 src/polar_sdk/orders.py: - last_write_checksum: sha1:2007a9818c19771f86e10a1c3f9efc77f9c07c13 + last_write_checksum: sha1:adbd235d4e78885a6c47a78f6fb836d5ea4adcd4 src/polar_sdk/organizations.py: last_write_checksum: sha1:ae0347ed0322fc273f2b9d4e2737823b458d6d73 src/polar_sdk/payments.py: @@ -9230,13 +9314,13 @@ trackedFiles: src/polar_sdk/polar_customer_portal_members.py: last_write_checksum: sha1:77739b38a54bed95d3d6d7f1255cf86a457884b0 src/polar_sdk/polar_customers.py: - last_write_checksum: sha1:8d64324cbf590f2b9d9a13968291107bf7b1051e + last_write_checksum: sha1:dfca704b0a1400b96b89c55754aba9c501c4e101 src/polar_sdk/polar_license_keys.py: - last_write_checksum: sha1:1a7c80b3a714a8ac6b665ba73812550021223753 + last_write_checksum: sha1:06b3655f6c622e17288780eac4152736b6eb33c9 src/polar_sdk/polar_members.py: last_write_checksum: sha1:3f597c46d2e570bc1460d82a001a49daf729d181 src/polar_sdk/polar_orders.py: - last_write_checksum: sha1:9e76cae96c127d47f2e28a1d4d426c849dcd9447 + last_write_checksum: sha1:979d6fa584957ae55b3d8841a9bb1047b6ff764f src/polar_sdk/polar_organizations.py: last_write_checksum: sha1:c6298efce671945b44ad0fb1e0916b1a26f3b224 src/polar_sdk/polar_subscriptions.py: diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 5bc5c3cf..64386474 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -32,7 +32,7 @@ generation: persistentEdits: {} versioningStrategy: automatic python: - version: 0.32.0 + version: 0.32.1 additionalDependencies: dev: pydantic-ai-slim: ^0.1.0 diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index c55ad765..9b6fbc8f 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:9cf091f91ef4a46970ede3273ee33e541c996281ec50ce88b55131f7d05e9b8c - sourceBlobDigest: sha256:bd427b992ceeb027fb3495c84d300ac99b300e03c96a775cd948e837b8ca9994 + sourceRevisionDigest: sha256:8b08c8a931b04f7c6eb360b9de22d2e6d91625ba477f594f1e11afb70e0223d2 + sourceBlobDigest: sha256:e1bd99441a0ba7cae08e24851b0486420b4aba343efec245bb3151f56396d7a5 tags: - latest - - speakeasy-sdk-regen-1781311562 + - speakeasy-sdk-regen-1784593801 - 2026-04 targets: polar: source: Polar-OAS sourceNamespace: polar-oas - sourceRevisionDigest: sha256:9cf091f91ef4a46970ede3273ee33e541c996281ec50ce88b55131f7d05e9b8c - sourceBlobDigest: sha256:bd427b992ceeb027fb3495c84d300ac99b300e03c96a775cd948e837b8ca9994 + sourceRevisionDigest: sha256:8b08c8a931b04f7c6eb360b9de22d2e6d91625ba477f594f1e11afb70e0223d2 + sourceBlobDigest: sha256:e1bd99441a0ba7cae08e24851b0486420b4aba343efec245bb3151f56396d7a5 codeSamplesNamespace: polar-oas-py-code-samples - codeSamplesRevisionDigest: sha256:6351e6c063d48f2c1f108519dd311ee4340131943242e7c054acef26fa717322 + codeSamplesRevisionDigest: sha256:1b88c14ecd47107d3cd73ed30c25260a488f15a08f3bb323b872d8c9e117ed3f workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/RELEASES.md b/RELEASES.md index 0d26afcb..ea2f5d4e 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -1153,4 +1153,14 @@ Based on: ### Generated - [python v0.32.0] . ### Releases -- [PyPI v0.32.0] https://pypi.org/project/polar-sdk/0.32.0 - . \ No newline at end of file +- [PyPI v0.32.0] https://pypi.org/project/polar-sdk/0.32.0 - . + +## 2026-07-28 00:28:57 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.648.0 (2.737.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v0.32.1] . +### Releases +- [PyPI v0.32.1] https://pypi.org/project/polar-sdk/0.32.1 - . \ No newline at end of file diff --git a/codeSamples.yaml b/codeSamples.yaml index c3013db9..eb54c917 100644 --- a/codeSamples.yaml +++ b/codeSamples.yaml @@ -1082,7 +1082,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.webhooks.create_webhook_endpoint(request={\n \"url\": \"https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0\",\n \"format_\": polar_sdk.WebhookFormat.SLACK,\n \"events\": [\n polar_sdk.WebhookEventType.SUBSCRIPTION_CANCELED,\n ],\n \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\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.webhooks.create_webhook_endpoint(request={\n \"url\": \"https://webhook.site/cb791d80-f26e-4f8c-be88-6e56054192b0\",\n \"format_\": polar_sdk.WebhookFormat.SLACK,\n \"events\": [\n polar_sdk.WebhookEventType.SUBSCRIPTION_CYCLED,\n ],\n \"organization_id\": \"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n })\n\n # Handle response\n print(res)" - target: $["paths"]["/v1/webhooks/endpoints/{id}"]["delete"] update: "x-codeSamples": @@ -1154,19 +1154,19 @@ 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.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 tax_behavior=polar_sdk.TaxBehavior.INCLUSIVE,\n total_amount=322400,\n currency=\"Boliviano boliviano\",\n allow_trial=False,\n active_trial_interval=polar_sdk.TrialInterval.DAY,\n active_trial_interval_count=None,\n trial_end=parse_datetime(\"2024-05-07T13:53:51.913Z\"),\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=True,\n is_payment_form_required=False,\n customer_id=\"\",\n is_business_customer=True,\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.OPTIONAL,\n state=polar_sdk.BillingAddressFieldMode.REQUIRED,\n city=polar_sdk.BillingAddressFieldMode.DISABLED,\n postal_code=polar_sdk.BillingAddressFieldMode.REQUIRED,\n line1=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n line2=polar_sdk.BillingAddressFieldMode.DISABLED,\n ),\n trial_interval=polar_sdk.TrialInterval.YEAR,\n trial_interval_count=None,\n metadata={\n\n },\n external_customer_id=\"\",\n products=[\n 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.RecurringInterval.YEAR,\n recurring_interval_count=265994,\n meter_interval=None,\n meter_interval_count=655705,\n is_recurring=False,\n is_archived=True,\n organization_id=\"\",\n prices=[],\n benefits=[],\n medias=[\n polar_sdk.ProductMediaFileRead(\n id=\"\",\n organization_id=\"\",\n name=\"\",\n path=\"/lost+found\",\n mime_type=\"\",\n size=554797,\n storage_version=\"\",\n checksum_etag=\"\",\n checksum_sha256_base64=\"\",\n checksum_sha256_hex=\"\",\n last_modified_at=parse_datetime(\"2025-08-28T17:10:35.995Z\"),\n version=\"\",\n is_uploaded=False,\n created_at=parse_datetime(\"2025-04-26T07:56:31.500Z\"),\n size_readable=\"\",\n public_url=\"https://salty-ribbon.com\",\n ),\n ],\n ),\n ],\n product=None,\n product_price=polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2024-03-22T00:37:19.107Z\"),\n modified_at=parse_datetime(\"2025-09-18T07:26:08.380Z\"),\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.RecurringInterval.YEAR,\n price_amount=445418,\n ),\n prices={\n \"key\": [\n polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2026-05-31T15:03:57.964Z\"),\n modified_at=parse_datetime(\"2024-07-27T13:28:27.335Z\"),\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.RecurringInterval.DAY,\n price_amount=618605,\n ),\n ],\n \"key1\": [\n polar_sdk.ProductPriceMeteredUnit(\n created_at=parse_datetime(\"2025-08-25T01:30:01.521Z\"),\n modified_at=parse_datetime(\"2025-03-28T21:18:04.322Z\"),\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 unit_amount=\"\",\n cap_amount=551606,\n meter_id=\"\",\n meter=polar_sdk.ProductPriceMeter(\n id=\"\",\n name=\"\",\n unit=polar_sdk.MeterUnit.SCALAR,\n custom_label=\"\",\n custom_multiplier=174683,\n ),\n ),\n ],\n },\n discount=None,\n subscription_id=\"\",\n attached_custom_fields=[],\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_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 tax_behavior=polar_sdk.TaxBehavior.INCLUSIVE,\n total_amount=322400,\n currency=\"Boliviano boliviano\",\n allow_trial=False,\n active_trial_interval=polar_sdk.TrialInterval.DAY,\n active_trial_interval_count=None,\n trial_end=parse_datetime(\"2024-05-07T13:53:51.913Z\"),\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=True,\n is_payment_form_required=False,\n customer_id=\"\",\n is_business_customer=True,\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_method_type=\"\",\n payment_processor_metadata={\n \"key\": \"\",\n \"key1\": \"\",\n },\n billing_address_fields=polar_sdk.CheckoutBillingAddressFields(\n country=polar_sdk.BillingAddressFieldMode.REQUIRED,\n state=polar_sdk.BillingAddressFieldMode.DISABLED,\n city=polar_sdk.BillingAddressFieldMode.REQUIRED,\n postal_code=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n line1=polar_sdk.BillingAddressFieldMode.DISABLED,\n line2=polar_sdk.BillingAddressFieldMode.DISABLED,\n ),\n trial_interval=polar_sdk.TrialInterval.DAY,\n trial_interval_count=138362,\n metadata={\n \"key\": \"\",\n },\n external_customer_id=\"\",\n products=[],\n product=polar_sdk.CheckoutProduct(\n id=\"\",\n created_at=parse_datetime(\"2025-07-06T07:35:44.280Z\"),\n modified_at=parse_datetime(\"2025-10-08T20:45:26.653Z\"),\n trial_interval=polar_sdk.TrialInterval.WEEK,\n trial_interval_count=None,\n name=\"\",\n description=\"brave siege deliberately yahoo yieldingly yuck until\",\n visibility=polar_sdk.ProductVisibility.PRIVATE,\n recurring_interval=polar_sdk.RecurringInterval.YEAR,\n recurring_interval_count=654854,\n meter_interval=polar_sdk.RecurringInterval.WEEK,\n meter_interval_count=703854,\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-10-21T16:07:40.109Z\"),\n modified_at=parse_datetime(\"2024-03-22T00:37:19.107Z\"),\n type=polar_sdk.BenefitType.DOWNLOADABLES,\n description=\"hexagon cope nab unimportant defenseless although obnoxiously\",\n selectable=True,\n deletable=False,\n is_deleted=False,\n organization_id=\"\",\n ),\n ],\n medias=[\n polar_sdk.ProductMediaFileRead(\n id=\"\",\n organization_id=\"\",\n name=\"\",\n path=\"/root\",\n mime_type=\"\",\n size=68559,\n storage_version=\"\",\n checksum_etag=\"\",\n checksum_sha256_base64=\"\",\n checksum_sha256_hex=\"\",\n last_modified_at=None,\n version=\"\",\n is_uploaded=False,\n created_at=parse_datetime(\"2025-08-14T23:26:30.929Z\"),\n size_readable=\"\",\n public_url=\"https://respectful-warming.org/\",\n ),\n ],\n ),\n product_price=polar_sdk.ProductPriceSeatBased(\n created_at=parse_datetime(\"2026-10-08T17:13:41.913Z\"),\n modified_at=parse_datetime(\"2024-06-28T11:47:03.272Z\"),\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 seat_tiers=polar_sdk.ProductPriceSeatTiersOutput(\n tiers=[\n polar_sdk.ProductPriceSeatTier(\n min_seats=357236,\n price_per_seat=657601,\n ),\n ],\n minimum_seats=287910,\n maximum_seats=357440,\n ),\n ),\n prices={\n \"key\": [\n polar_sdk.ProductPriceMeteredUnit(\n created_at=parse_datetime(\"2024-09-11T20:26:20.871Z\"),\n modified_at=None,\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 unit_amount=\"\",\n cap_amount=800933,\n meter_id=\"\",\n meter=polar_sdk.ProductPriceMeter(\n id=\"\",\n name=\"\",\n unit=polar_sdk.MeterUnit.CUSTOM,\n custom_label=\"\",\n custom_multiplier=None,\n ),\n ),\n ],\n \"key1\": [\n polar_sdk.LegacyRecurringProductPriceCustom(\n created_at=parse_datetime(\"2024-01-28T19:25:32.234Z\"),\n modified_at=parse_datetime(\"2025-10-30T14:19:38.353Z\"),\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.RecurringInterval.DAY,\n minimum_amount=484796,\n maximum_amount=240218,\n preset_amount=851525,\n ),\n ],\n \"key2\": [],\n },\n discount=polar_sdk.CheckoutDiscountFixedOnceForeverDuration(\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 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.CustomFieldCheckbox(\n created_at=parse_datetime(\"2024-07-03T08:52:14.626Z\"),\n modified_at=parse_datetime(\"2025-10-29T10:43:02.267Z\"),\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=561350,\n required=False,\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 tax_behavior=polar_sdk.TaxBehavior.INCLUSIVE,\n total_amount=891839,\n currency=\"Iceland Krona\",\n allow_trial=True,\n active_trial_interval=polar_sdk.TrialInterval.YEAR,\n active_trial_interval_count=993333,\n trial_end=parse_datetime(\"2026-02-10T15:12:42.397Z\"),\n organization_id=\"\",\n product_id=\"\",\n product_price_id=\"\",\n discount_id=\"\",\n allow_discount_codes=True,\n require_billing_address=True,\n is_discount_applicable=False,\n is_free_product_price=True,\n is_payment_required=True,\n is_payment_setup_required=False,\n is_payment_form_required=False,\n customer_id=\"\",\n is_business_customer=True,\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 },\n billing_address_fields=polar_sdk.CheckoutBillingAddressFields(\n country=polar_sdk.BillingAddressFieldMode.DISABLED,\n state=polar_sdk.BillingAddressFieldMode.REQUIRED,\n city=polar_sdk.BillingAddressFieldMode.REQUIRED,\n postal_code=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n line1=polar_sdk.BillingAddressFieldMode.DISABLED,\n line2=polar_sdk.BillingAddressFieldMode.DISABLED,\n ),\n trial_interval=polar_sdk.TrialInterval.WEEK,\n trial_interval_count=688555,\n metadata={\n \"key\": \"\",\n },\n external_customer_id=\"\",\n products=[],\n product=None,\n product_price=polar_sdk.ProductPriceSeatBased(\n created_at=parse_datetime(\"2026-01-06T18:52:18.062Z\"),\n modified_at=parse_datetime(\"2025-05-10T14:44:05.951Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.CATALOG,\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 minimum_seats=400901,\n maximum_seats=638464,\n ),\n ),\n prices=None,\n discount=polar_sdk.CheckoutDiscountFixedOnceForeverDuration(\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 id=\"\",\n name=\"\",\n code=None,\n ),\n subscription_id=\"\",\n attached_custom_fields=[],\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 tax_behavior=polar_sdk.TaxBehavior.INCLUSIVE,\n total_amount=891839,\n currency=\"Iceland Krona\",\n allow_trial=True,\n active_trial_interval=polar_sdk.TrialInterval.YEAR,\n active_trial_interval_count=993333,\n trial_end=parse_datetime(\"2026-02-10T15:12:42.397Z\"),\n organization_id=\"\",\n product_id=\"\",\n product_price_id=\"\",\n discount_id=\"\",\n allow_discount_codes=True,\n require_billing_address=True,\n is_discount_applicable=False,\n is_free_product_price=True,\n is_payment_required=True,\n is_payment_setup_required=False,\n is_payment_form_required=False,\n customer_id=\"\",\n is_business_customer=True,\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_method_type=\"\",\n payment_processor_metadata={\n \"key\": \"\",\n \"key1\": \"\",\n \"key2\": \"\",\n },\n billing_address_fields=polar_sdk.CheckoutBillingAddressFields(\n country=polar_sdk.BillingAddressFieldMode.REQUIRED,\n state=polar_sdk.BillingAddressFieldMode.REQUIRED,\n city=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n postal_code=polar_sdk.BillingAddressFieldMode.DISABLED,\n line1=polar_sdk.BillingAddressFieldMode.DISABLED,\n line2=polar_sdk.BillingAddressFieldMode.REQUIRED,\n ),\n trial_interval=polar_sdk.TrialInterval.WEEK,\n trial_interval_count=593284,\n metadata={\n\n },\n external_customer_id=\"\",\n products=[],\n product=None,\n product_price=polar_sdk.ProductPriceSeatBased(\n created_at=parse_datetime(\"2026-01-06T18:52:18.062Z\"),\n modified_at=parse_datetime(\"2025-05-10T14:44:05.951Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.CATALOG,\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 minimum_seats=400901,\n maximum_seats=638464,\n ),\n ),\n prices=None,\n discount=polar_sdk.CheckoutDiscountFixedOnceForeverDuration(\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 id=\"\",\n name=\"\",\n code=None,\n ),\n subscription_id=\"\",\n attached_custom_fields=[],\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 tax_behavior=None,\n total_amount=59172,\n currency=\"New Taiwan Dollar\",\n allow_trial=True,\n active_trial_interval=polar_sdk.TrialInterval.MONTH,\n active_trial_interval_count=675563,\n trial_end=parse_datetime(\"2024-11-02T00:27:36.754Z\"),\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=True,\n is_free_product_price=True,\n is_payment_required=True,\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 \"key\": \"\",\n \"key1\": \"\",\n },\n billing_address_fields=polar_sdk.CheckoutBillingAddressFields(\n country=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n state=polar_sdk.BillingAddressFieldMode.REQUIRED,\n city=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n postal_code=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n line1=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n line2=polar_sdk.BillingAddressFieldMode.DISABLED,\n ),\n trial_interval=polar_sdk.TrialInterval.MONTH,\n trial_interval_count=899080,\n metadata={\n\n },\n external_customer_id=\"\",\n products=[],\n product=polar_sdk.CheckoutProduct(\n id=\"\",\n created_at=parse_datetime(\"2025-09-06T09:34:57.464Z\"),\n modified_at=parse_datetime(\"2024-01-24T09:30:59.881Z\"),\n trial_interval=polar_sdk.TrialInterval.YEAR,\n trial_interval_count=881833,\n name=\"\",\n description=\"needily past pause different wallaby micromanage yahoo thin instead woeful\",\n visibility=polar_sdk.ProductVisibility.PUBLIC,\n recurring_interval=polar_sdk.RecurringInterval.DAY,\n recurring_interval_count=297888,\n meter_interval=polar_sdk.RecurringInterval.WEEK,\n meter_interval_count=964345,\n is_recurring=True,\n is_archived=True,\n organization_id=\"\",\n prices=[\n polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2025-01-20T07:54:45.660Z\"),\n modified_at=parse_datetime(\"2025-11-06T23:16:23.807Z\"),\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.RecurringInterval.YEAR,\n price_amount=894786,\n ),\n ],\n benefits=[\n polar_sdk.BenefitPublic(\n id=\"\",\n created_at=parse_datetime(\"2025-08-12T14:24:20.342Z\"),\n modified_at=parse_datetime(\"2024-07-31T03:55:09.650Z\"),\n type=polar_sdk.BenefitType.SLACK_SHARED_CHANNEL,\n description=\"beyond athwart youthful greedy eyeliner ouch faithfully kindly\",\n selectable=True,\n deletable=False,\n is_deleted=False,\n organization_id=\"\",\n ),\n ],\n medias=[\n polar_sdk.ProductMediaFileRead(\n id=\"\",\n organization_id=\"\",\n name=\"\",\n path=\"/home\",\n mime_type=\"\",\n size=983809,\n storage_version=\"\",\n checksum_etag=\"\",\n checksum_sha256_base64=\"\",\n checksum_sha256_hex=\"\",\n last_modified_at=parse_datetime(\"2024-04-29T02:53:02.623Z\"),\n version=\"\",\n is_uploaded=False,\n created_at=parse_datetime(\"2024-01-15T02:23:23.630Z\"),\n size_readable=\"\",\n public_url=\"https://quiet-impact.info/\",\n ),\n ],\n ),\n product_price=None,\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)" + "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 tax_behavior=None,\n total_amount=59172,\n currency=\"New Taiwan Dollar\",\n allow_trial=True,\n active_trial_interval=polar_sdk.TrialInterval.MONTH,\n active_trial_interval_count=675563,\n trial_end=parse_datetime(\"2024-11-02T00:27:36.754Z\"),\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=True,\n is_free_product_price=True,\n is_payment_required=True,\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_method_type=\"\",\n payment_processor_metadata={\n \"key\": \"\",\n },\n billing_address_fields=polar_sdk.CheckoutBillingAddressFields(\n country=polar_sdk.BillingAddressFieldMode.REQUIRED,\n state=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n city=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n postal_code=polar_sdk.BillingAddressFieldMode.OPTIONAL,\n line1=polar_sdk.BillingAddressFieldMode.DISABLED,\n line2=polar_sdk.BillingAddressFieldMode.DISABLED,\n ),\n trial_interval=polar_sdk.TrialInterval.WEEK,\n trial_interval_count=310921,\n metadata={\n \"key\": \"\",\n },\n external_customer_id=\"\",\n products=[\n polar_sdk.CheckoutProduct(\n id=\"\",\n created_at=parse_datetime(\"2025-01-14T02:31:30.334Z\"),\n modified_at=None,\n trial_interval=polar_sdk.TrialInterval.YEAR,\n trial_interval_count=881833,\n name=\"\",\n description=\"needily past pause different wallaby micromanage yahoo thin instead woeful\",\n visibility=polar_sdk.ProductVisibility.PUBLIC,\n recurring_interval=polar_sdk.RecurringInterval.DAY,\n recurring_interval_count=297888,\n meter_interval=polar_sdk.RecurringInterval.WEEK,\n meter_interval_count=964345,\n is_recurring=True,\n is_archived=True,\n organization_id=\"\",\n prices=[\n polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2025-01-20T07:54:45.660Z\"),\n modified_at=parse_datetime(\"2025-11-06T23:16:23.807Z\"),\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.RecurringInterval.YEAR,\n price_amount=894786,\n ),\n ],\n benefits=[\n polar_sdk.BenefitPublic(\n id=\"\",\n created_at=parse_datetime(\"2025-08-12T14:24:20.342Z\"),\n modified_at=parse_datetime(\"2024-07-31T03:55:09.650Z\"),\n type=polar_sdk.BenefitType.SLACK_SHARED_CHANNEL,\n description=\"beyond athwart youthful greedy eyeliner ouch faithfully kindly\",\n selectable=True,\n deletable=False,\n is_deleted=False,\n organization_id=\"\",\n ),\n ],\n medias=[\n polar_sdk.ProductMediaFileRead(\n id=\"\",\n organization_id=\"\",\n name=\"\",\n path=\"/home\",\n mime_type=\"\",\n size=983809,\n storage_version=\"\",\n checksum_etag=\"\",\n checksum_sha256_base64=\"\",\n checksum_sha256_hex=\"\",\n last_modified_at=parse_datetime(\"2024-04-29T02:53:02.623Z\"),\n version=\"\",\n is_uploaded=False,\n created_at=parse_datetime(\"2024-01-15T02:23:23.630Z\"),\n size_readable=\"\",\n public_url=\"https://quiet-impact.info/\",\n ),\n ],\n ),\n ],\n product=None,\n product_price=polar_sdk.LegacyRecurringProductPriceCustom(\n created_at=parse_datetime(\"2025-06-23T05:24:14.067Z\"),\n modified_at=parse_datetime(\"2024-11-13T11:44:44.642Z\"),\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.RecurringInterval.DAY,\n minimum_amount=66,\n maximum_amount=923949,\n preset_amount=245326,\n ),\n prices=None,\n discount=polar_sdk.CheckoutDiscountFixedRepeatDuration(\n duration=polar_sdk.DiscountDuration.REPEATING,\n duration_in_months=46326,\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 polar_sdk.AttachedCustomField(\n custom_field_id=\"\",\n custom_field=polar_sdk.CustomFieldDate(\n created_at=parse_datetime(\"2025-01-17T17:30:50.838Z\"),\n modified_at=parse_datetime(\"2025-08-11T10:13:55.906Z\"),\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=786409,\n required=False,\n ),\n ],\n customer_metadata={\n\n },\n ),\n ))\n\n # Handle response\n print(res)" - target: $["paths"]["customer.created"]["post"] update: "x-codeSamples": @@ -1209,6 +1209,24 @@ actions: - "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_seat_revoked_post(request={\n \"type\": \"customer_seat.revoked\",\n \"timestamp\": parse_datetime(\"2024-11-11T11:49:39.839Z\"),\n \"data\": {\n \"created_at\": parse_datetime(\"2025-08-05T10:54:13.336Z\"),\n \"modified_at\": parse_datetime(\"2024-12-01T21:24:11.844Z\"),\n \"id\": \"518899df-02c0-4220-abaf-0f2f32e97539\",\n \"subscription_id\": None,\n \"order_id\": \"99b8869b-660e-4fb9-9583-4adb0a833fd3\",\n \"status\": polar_sdk.SeatStatus.REVOKED,\n \"customer_id\": \"1e3cd09b-b395-43f8-a931-80fb59e39a9c\",\n \"member_id\": \"a48412a7-68b5-4144-9983-7afb65173beb\",\n \"member\": {\n \"id\": \"\",\n \"created_at\": parse_datetime(\"2024-08-26T22:21:14.954Z\"),\n \"modified_at\": parse_datetime(\"2025-02-08T09:01:13.408Z\"),\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 \"email\": \"Franz_Wintheiser@gmail.com\",\n \"customer_email\": \"\",\n \"invitation_token_expires_at\": parse_datetime(\"2024-09-11T08:28:43.798Z\"),\n \"claimed_at\": parse_datetime(\"2025-02-20T06:37:06.582Z\"),\n \"revoked_at\": parse_datetime(\"2025-10-22T07:27:15.954Z\"),\n \"seat_metadata\": {\n \"key\": \"\",\n },\n },\n })\n\n # Handle response\n print(res)" + - target: $["paths"]["discount.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.endpointdiscount_created_post(request=polar_sdk.WebhookDiscountCreatedPayload(\n timestamp=parse_datetime(\"2026-06-01T12:33:29.570Z\"),\n data=polar_sdk.DiscountFixedRepeatDuration(\n duration=polar_sdk.DiscountDuration.REPEATING,\n duration_in_months=179751,\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-02-21T05:24:48.689Z\"),\n modified_at=parse_datetime(\"2026-09-12T01:20:52.031Z\"),\n id=\"\",\n metadata={\n \"key\": \"\",\n },\n name=\"\",\n code=\"\",\n starts_at=parse_datetime(\"2025-02-13T09:12:55.294Z\"),\n ends_at=parse_datetime(\"2024-10-07T21:58:26.782Z\"),\n max_redemptions=79512,\n redemptions_count=223951,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n products=[],\n ),\n ))\n\n # Handle response\n print(res)" + - target: $["paths"]["discount.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.endpointdiscount_deleted_post(request=polar_sdk.WebhookDiscountDeletedPayload(\n timestamp=parse_datetime(\"2025-02-20T22:30:40.844Z\"),\n data=polar_sdk.DiscountPercentageOnceForeverDuration(\n duration=polar_sdk.DiscountDuration.REPEATING,\n type=polar_sdk.DiscountType.PERCENTAGE,\n basis_points=1000,\n created_at=parse_datetime(\"2026-04-12T18:41:55.855Z\"),\n modified_at=parse_datetime(\"2025-03-02T23:37:37.703Z\"),\n id=\"\",\n metadata={\n\n },\n name=\"\",\n code=\"\",\n starts_at=parse_datetime(\"2026-03-19T00:46:24.443Z\"),\n ends_at=parse_datetime(\"2025-12-16T17:40:07.633Z\"),\n max_redemptions=620156,\n redemptions_count=551200,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n products=[],\n ),\n ))\n\n # Handle response\n print(res)" + - target: $["paths"]["discount.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.endpointdiscount_updated_post(request=polar_sdk.WebhookDiscountUpdatedPayload(\n timestamp=parse_datetime(\"2025-11-10T23:02:41.327Z\"),\n data=polar_sdk.DiscountFixedOnceForeverDuration(\n duration=polar_sdk.DiscountDuration.REPEATING,\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-06-18T18:53:28.965Z\"),\n modified_at=parse_datetime(\"2024-09-19T20:57:06.225Z\"),\n id=\"\",\n metadata={\n \"key\": False,\n },\n name=\"\",\n code=\"\",\n starts_at=parse_datetime(\"2024-07-07T11:25:38.360Z\"),\n ends_at=parse_datetime(\"2025-10-12T09:13:06.811Z\"),\n max_redemptions=794318,\n redemptions_count=991313,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n products=[\n polar_sdk.DiscountProduct(\n metadata={\n\n },\n id=\"\",\n created_at=parse_datetime(\"2024-01-05T04:00:27.311Z\"),\n modified_at=parse_datetime(\"2025-10-20T14:01:27.634Z\"),\n trial_interval=polar_sdk.TrialInterval.WEEK,\n trial_interval_count=None,\n name=\"\",\n description=\"slipper nor nervously from\",\n visibility=polar_sdk.ProductVisibility.DRAFT,\n recurring_interval=polar_sdk.RecurringInterval.YEAR,\n recurring_interval_count=457560,\n meter_interval=polar_sdk.RecurringInterval.MONTH,\n meter_interval_count=475768,\n is_recurring=False,\n is_archived=False,\n organization_id=\"\",\n ),\n ],\n ),\n ))\n\n # Handle response\n print(res)" - target: $["paths"]["member.created"]["post"] update: "x-codeSamples": @@ -1299,6 +1317,12 @@ actions: - "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.RecurringInterval.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 current_meter_period_start=parse_datetime(\"2024-10-19T18:48:25.568Z\"),\n current_meter_period_end=parse_datetime(\"2024-09-09T18:39:16.136Z\"),\n trial_start=parse_datetime(\"2026-08-30T21:29:16.432Z\"),\n trial_end=parse_datetime(\"2025-06-27T22:01:23.333Z\"),\n cancel_at_period_end=True,\n canceled_at=parse_datetime(\"2024-03-14T19:14:53.866Z\"),\n started_at=parse_datetime(\"2025-04-01T08:29:51.925Z\"),\n ends_at=parse_datetime(\"2026-03-08T09:50:30.968Z\"),\n ended_at=parse_datetime(\"2026-04-17T21:09:13.571Z\"),\n pause_at_period_end=False,\n paused_at=parse_datetime(\"2025-09-10T08:59:46.091Z\"),\n resumes_at=parse_datetime(\"2025-07-06T00:27:46.272Z\"),\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n checkout_id=\"\",\n customer_cancellation_reason=polar_sdk.CustomerCancellationReason.OTHER,\n customer_cancellation_comment=\"\",\n metadata={\n \"key\": \"\",\n },\n customer=polar_sdk.SubscriptionCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2025-05-25T09:51:02.679Z\"),\n modified_at=parse_datetime(\"2026-12-23T23:39:23.705Z\"),\n metadata={\n \"key\": True,\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_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-03-20T19:49:24.750Z\"),\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-08-05T20:29:17.317Z\"),\n modified_at=parse_datetime(\"2026-07-24T03:08:01.085Z\"),\n trial_interval=polar_sdk.TrialInterval.MONTH,\n trial_interval_count=41100,\n name=\"\",\n description=\"cemetery hydrocarbon a fledgling knit shirk appertain\",\n visibility=polar_sdk.ProductVisibility.PUBLIC,\n recurring_interval=polar_sdk.RecurringInterval.YEAR,\n recurring_interval_count=751680,\n meter_interval=polar_sdk.RecurringInterval.MONTH,\n meter_interval_count=149871,\n is_recurring=True,\n is_archived=False,\n organization_id=\"\",\n metadata={\n\n },\n prices=[\n polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2025-04-27T20:47:28.086Z\"),\n modified_at=parse_datetime(\"2024-06-06T17:00:51.370Z\"),\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.RecurringInterval.WEEK,\n price_amount=839880,\n ),\n ],\n benefits=[\n polar_sdk.BenefitMeterCredit(\n id=\"\",\n created_at=parse_datetime(\"2026-08-26T08:46:11.221Z\"),\n modified_at=parse_datetime(\"2025-03-03T14:17:25.891Z\"),\n description=\"basic reassuringly even blah between qua proud divert pulse\",\n selectable=False,\n deletable=False,\n is_deleted=False,\n organization_id=\"\",\n metadata={\n \"key\": True,\n },\n visibility=polar_sdk.BenefitVisibility.DRAFT,\n properties=polar_sdk.BenefitMeterCreditProperties(\n units=719151,\n rollover=False,\n meter_id=\"\",\n ),\n visibility_configurable=True,\n ),\n ],\n medias=[\n polar_sdk.ProductMediaFileRead(\n id=\"\",\n organization_id=\"\",\n name=\"\",\n path=\"/var/spool\",\n mime_type=\"\",\n size=844007,\n storage_version=\"\",\n checksum_etag=\"\",\n checksum_sha256_base64=\"\",\n checksum_sha256_hex=\"\",\n last_modified_at=None,\n version=\"\",\n is_uploaded=True,\n created_at=parse_datetime(\"2026-01-19T13:50:05.319Z\"),\n size_readable=\"\",\n public_url=\"https://insecure-reorganisation.info\",\n ),\n ],\n attached_custom_fields=[],\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(\"2024-11-04T12:34:14.601Z\"),\n modified_at=parse_datetime(\"2025-09-17T01:44:56.143Z\"),\n id=\"\",\n metadata={\n\n },\n name=\"\",\n code=\"\",\n starts_at=parse_datetime(\"2024-08-16T12:34:58.120Z\"),\n ends_at=parse_datetime(\"2024-03-17T04:09:23.349Z\"),\n max_redemptions=34043,\n redemptions_count=908029,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n prices=[\n polar_sdk.ProductPriceSeatBased(\n created_at=parse_datetime(\"2026-05-17T01:58:02.155Z\"),\n modified_at=parse_datetime(\"2025-09-29T09:35:40.427Z\"),\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 seat_tiers=polar_sdk.ProductPriceSeatTiersOutput(\n tiers=[],\n minimum_seats=535004,\n maximum_seats=725538,\n ),\n ),\n ],\n meters=[],\n pending_update=polar_sdk.PendingSubscriptionUpdate(\n created_at=parse_datetime(\"2026-07-21T08:23:35.547Z\"),\n modified_at=None,\n id=\"\",\n applies_at=parse_datetime(\"2025-08-10T23:45:43.450Z\"),\n product_id=\"\",\n seats=607419,\n ),\n ),\n ))\n\n # Handle response\n print(res)" + - target: $["paths"]["subscription.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.endpointsubscription_cycled_post(request=polar_sdk.WebhookSubscriptionCycledPayload(\n timestamp=parse_datetime(\"2024-08-26T09:51:17.561Z\"),\n data=polar_sdk.Subscription(\n created_at=parse_datetime(\"2024-11-19T00:31:08.557Z\"),\n modified_at=parse_datetime(\"2024-07-18T16:03:27.425Z\"),\n id=\"\",\n amount=10000,\n currency=\"usd\",\n recurring_interval=polar_sdk.RecurringInterval.YEAR,\n recurring_interval_count=542449,\n status=polar_sdk.SubscriptionStatus.TRIALING,\n current_period_start=parse_datetime(\"2024-11-18T05:58:07.773Z\"),\n current_period_end=parse_datetime(\"2026-05-27T12:28:57.938Z\"),\n current_meter_period_start=parse_datetime(\"2026-08-16T20:40:04.980Z\"),\n current_meter_period_end=parse_datetime(\"2025-02-19T23:53:59.708Z\"),\n trial_start=parse_datetime(\"2025-09-07T05:40:32.528Z\"),\n trial_end=None,\n cancel_at_period_end=True,\n canceled_at=parse_datetime(\"2025-08-17T15:55:05.116Z\"),\n started_at=parse_datetime(\"2024-09-06T12:23:00.011Z\"),\n ends_at=None,\n ended_at=parse_datetime(\"2024-05-15T10:03:04.868Z\"),\n pause_at_period_end=True,\n paused_at=parse_datetime(\"2024-12-22T00:45:23.828Z\"),\n resumes_at=parse_datetime(\"2026-06-04T03:28:46.748Z\"),\n customer_id=\"\",\n product_id=\"\",\n discount_id=\"\",\n checkout_id=\"\",\n customer_cancellation_reason=polar_sdk.CustomerCancellationReason.TOO_EXPENSIVE,\n customer_cancellation_comment=\"\",\n metadata={\n \"key\": 492829,\n },\n customer=polar_sdk.SubscriptionCustomer(\n id=\"992fae2a-2a17-4b7a-8d9e-e287cf90131b\",\n created_at=parse_datetime(\"2026-01-12T08:10:57.662Z\"),\n modified_at=parse_datetime(\"2025-04-02T22:57:12.765Z\"),\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_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-01-27T06:40:11.845Z\"),\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-03-31T23:41:50.445Z\"),\n modified_at=parse_datetime(\"2024-06-03T06:43:58.898Z\"),\n trial_interval=polar_sdk.TrialInterval.DAY,\n trial_interval_count=705527,\n name=\"\",\n description=\"purple bitterly yearn jovially speedily incidentally given toward meh\",\n visibility=polar_sdk.ProductVisibility.PRIVATE,\n recurring_interval=polar_sdk.RecurringInterval.YEAR,\n recurring_interval_count=28683,\n meter_interval=polar_sdk.RecurringInterval.MONTH,\n meter_interval_count=595551,\n is_recurring=False,\n is_archived=False,\n organization_id=\"\",\n metadata={\n\n },\n prices=[\n polar_sdk.LegacyRecurringProductPriceFixed(\n created_at=parse_datetime(\"2026-09-21T11:48:55.499Z\"),\n modified_at=parse_datetime(\"2026-08-19T04:17:33.887Z\"),\n id=\"\",\n source=polar_sdk.ProductPriceSource.CATALOG,\n price_currency=\"\",\n tax_behavior=polar_sdk.TaxBehaviorOption.INCLUSIVE,\n is_archived=False,\n product_id=\"\",\n recurring_interval=polar_sdk.RecurringInterval.WEEK,\n price_amount=414949,\n ),\n ],\n benefits=[],\n medias=[\n polar_sdk.ProductMediaFileRead(\n id=\"\",\n organization_id=\"\",\n name=\"\",\n path=\"/tmp\",\n mime_type=\"\",\n size=14330,\n storage_version=None,\n checksum_etag=\"\",\n checksum_sha256_base64=\"\",\n checksum_sha256_hex=\"\",\n last_modified_at=None,\n version=\"\",\n is_uploaded=True,\n created_at=parse_datetime(\"2026-02-20T12:55:41.520Z\"),\n size_readable=\"\",\n public_url=\"https://violent-circumference.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(\"2025-03-28T11:10:45.316Z\"),\n modified_at=None,\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=317704,\n required=True,\n ),\n ],\n ),\n discount=polar_sdk.DiscountFixedRepeatDurationBase(\n duration=polar_sdk.DiscountDuration.REPEATING,\n duration_in_months=76891,\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-05-16T10:26:47.253Z\"),\n modified_at=parse_datetime(\"2025-08-09T05:00:08.712Z\"),\n id=\"\",\n metadata={\n \"key\": False,\n },\n name=\"\",\n code=\"\",\n starts_at=parse_datetime(\"2024-02-25T19:10:52.902Z\"),\n ends_at=None,\n max_redemptions=499299,\n redemptions_count=424469,\n organization_id=\"1dbfc517-0bbf-4301-9ba8-555ca42b9737\",\n ),\n prices=[],\n meters=[\n polar_sdk.SubscriptionMeter(\n created_at=parse_datetime(\"2026-04-10T21:57:06.451Z\"),\n modified_at=parse_datetime(\"2026-11-20T01:13:24.879Z\"),\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-11T17:57:35.970Z\"),\n modified_at=parse_datetime(\"2025-07-16T11:20:00.879Z\"),\n id=\"\",\n name=\"\",\n unit=polar_sdk.MeterUnit.SCALAR,\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.MAX,\n property=\"\",\n ),\n organization_id=\"\",\n ),\n ),\n ],\n pending_update=polar_sdk.PendingSubscriptionUpdate(\n created_at=parse_datetime(\"2026-04-25T12:13:40.453Z\"),\n modified_at=parse_datetime(\"2025-12-21T21:33:16.851Z\"),\n id=\"\",\n applies_at=parse_datetime(\"2024-06-01T16:54:56.812Z\"),\n product_id=\"\",\n seats=74510,\n ),\n ),\n ))\n\n # Handle response\n print(res)" - target: $["paths"]["subscription.past_due"]["post"] update: "x-codeSamples": diff --git a/docs/models/checkout.md b/docs/models/checkout.md index a4bd7069..43ea69c0 100644 --- a/docs/models/checkout.md +++ b/docs/models/checkout.md @@ -53,6 +53,7 @@ Checkout session data retrieved using an access token. | `customer_billing_address` | [Nullable[models.Address]](../models/address.md) | :heavy_check_mark: | N/A | | `customer_tax_id` | *Nullable[str]* | :heavy_check_mark: | N/A | | `locale` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `payment_method_type` | *Nullable[str]* | :heavy_check_mark: | Payment method type selected by the customer in the checkout form, e.g. `card`, `apple_pay` or `upi`. | | `payment_processor_metadata` | Dict[str, *str*] | :heavy_check_mark: | N/A | | `billing_address_fields` | [models.CheckoutBillingAddressFields](../models/checkoutbillingaddressfields.md) | :heavy_check_mark: | N/A | | `trial_interval` | [Nullable[models.TrialInterval]](../models/trialinterval.md) | :heavy_check_mark: | The interval unit for the trial period. | diff --git a/docs/models/checkoutconfirmstripe.md b/docs/models/checkoutconfirmstripe.md index 665993a5..dc91d91b 100644 --- a/docs/models/checkoutconfirmstripe.md +++ b/docs/models/checkoutconfirmstripe.md @@ -19,6 +19,7 @@ Confirm a checkout session using a Stripe confirmation token. | `customer_billing_address` | [OptionalNullable[models.AddressInput]](../models/addressinput.md) | :heavy_minus_sign: | N/A | | | `customer_tax_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | | `locale` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | en | +| `payment_method_type` | *OptionalNullable[str]* | :heavy_minus_sign: | Payment method type selected by the customer in the checkout form, e.g. `card`, `apple_pay` or `upi`. | | | `discount_code` | *OptionalNullable[str]* | :heavy_minus_sign: | Discount code to apply to the checkout. | | | `allow_trial` | *OptionalNullable[Literal[False]]* | :heavy_minus_sign: | Disable the trial period for the checkout session. It's mainly useful when the trial is blocked because the customer already redeemed one. | | | `confirmation_token_id` | *OptionalNullable[str]* | :heavy_minus_sign: | ID of the Stripe confirmation token. Required for fixed prices and custom prices. | | \ No newline at end of file diff --git a/docs/models/checkoutpublic.md b/docs/models/checkoutpublic.md index 21f44dc1..719f2abd 100644 --- a/docs/models/checkoutpublic.md +++ b/docs/models/checkoutpublic.md @@ -53,6 +53,7 @@ Checkout session data retrieved using the client secret. | `customer_billing_address` | [Nullable[models.Address]](../models/address.md) | :heavy_check_mark: | N/A | | `customer_tax_id` | *Nullable[str]* | :heavy_check_mark: | N/A | | `locale` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `payment_method_type` | *Nullable[str]* | :heavy_check_mark: | Payment method type selected by the customer in the checkout form, e.g. `card`, `apple_pay` or `upi`. | | `payment_processor_metadata` | Dict[str, *str*] | :heavy_check_mark: | N/A | | `billing_address_fields` | [models.CheckoutBillingAddressFields](../models/checkoutbillingaddressfields.md) | :heavy_check_mark: | N/A | | `products` | List[[models.CheckoutProduct](../models/checkoutproduct.md)] | :heavy_check_mark: | List of products available to select. | diff --git a/docs/models/checkoutpublicconfirmed.md b/docs/models/checkoutpublicconfirmed.md index ace486f7..a5ea6f8d 100644 --- a/docs/models/checkoutpublicconfirmed.md +++ b/docs/models/checkoutpublicconfirmed.md @@ -56,6 +56,7 @@ right after the checkout. | `customer_billing_address` | [Nullable[models.Address]](../models/address.md) | :heavy_check_mark: | N/A | | `customer_tax_id` | *Nullable[str]* | :heavy_check_mark: | N/A | | `locale` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | +| `payment_method_type` | *Nullable[str]* | :heavy_check_mark: | Payment method type selected by the customer in the checkout form, e.g. `card`, `apple_pay` or `upi`. | | `payment_processor_metadata` | Dict[str, *str*] | :heavy_check_mark: | N/A | | `billing_address_fields` | [models.CheckoutBillingAddressFields](../models/checkoutbillingaddressfields.md) | :heavy_check_mark: | N/A | | `products` | List[[models.CheckoutProduct](../models/checkoutproduct.md)] | :heavy_check_mark: | List of products available to select. | diff --git a/docs/models/checkoutupdatepublic.md b/docs/models/checkoutupdatepublic.md index 8a9ba5cb..81c5b63a 100644 --- a/docs/models/checkoutupdatepublic.md +++ b/docs/models/checkoutupdatepublic.md @@ -19,5 +19,6 @@ Update an existing checkout session using the client secret. | `customer_billing_address` | [OptionalNullable[models.AddressInput]](../models/addressinput.md) | :heavy_minus_sign: | N/A | | | `customer_tax_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | | | `locale` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | en | +| `payment_method_type` | *OptionalNullable[str]* | :heavy_minus_sign: | Payment method type selected by the customer in the checkout form, e.g. `card`, `apple_pay` or `upi`. | | | `discount_code` | *OptionalNullable[str]* | :heavy_minus_sign: | Discount code to apply to the checkout. | | | `allow_trial` | *OptionalNullable[Literal[False]]* | :heavy_minus_sign: | Disable the trial period for the checkout session. It's mainly useful when the trial is blocked because the customer already redeemed one. | | \ No newline at end of file diff --git a/docs/models/orderunvoidedevent.md b/docs/models/orderunvoidedevent.md new file mode 100644 index 00000000..b6dfea7b --- /dev/null +++ b/docs/models/orderunvoidedevent.md @@ -0,0 +1,23 @@ +# OrderUnvoidedEvent + +An event created by Polar when an order is unvoided. + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `id` | *str* | :heavy_check_mark: | The ID of the object. | | +| `timestamp` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The timestamp of the event. | | +| `organization_id` | *str* | :heavy_check_mark: | The ID of the organization owning the event. | 1dbfc517-0bbf-4301-9ba8-555ca42b9737 | +| `customer_id` | *Nullable[str]* | :heavy_check_mark: | ID of the customer in your Polar organization associated with the event. | | +| `customer` | [Nullable[models.Customer]](../models/customer.md) | :heavy_check_mark: | The customer associated with the event. | | +| `external_customer_id` | *Nullable[str]* | :heavy_check_mark: | ID of the customer in your system associated with the event. | | +| `member_id` | *OptionalNullable[str]* | :heavy_minus_sign: | ID of the member within the customer's organization who performed the action inside B2B. | | +| `external_member_id` | *OptionalNullable[str]* | :heavy_minus_sign: | ID of the member in your system within the customer's organization who performed the action inside B2B. | | +| `child_count` | *Optional[int]* | :heavy_minus_sign: | Number of direct child events linked to this event. | | +| `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the parent event. | | +| `label` | *str* | :heavy_check_mark: | Human readable label of the event type. | | +| `source` | *Literal["system"]* | :heavy_check_mark: | The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. | | +| `name` | *Literal["order.unvoided"]* | :heavy_check_mark: | The name of the event. | | +| `metadata` | [models.OrderUnvoidedMetadata](../models/orderunvoidedmetadata.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/orderunvoidedmetadata.md b/docs/models/orderunvoidedmetadata.md new file mode 100644 index 00000000..d007e83b --- /dev/null +++ b/docs/models/orderunvoidedmetadata.md @@ -0,0 +1,10 @@ +# OrderUnvoidedMetadata + + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `order_id` | *str* | :heavy_check_mark: | N/A | +| `amount` | *int* | :heavy_check_mark: | N/A | +| `currency` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/subscriptionreinstatedevent.md b/docs/models/subscriptionreinstatedevent.md new file mode 100644 index 00000000..bfc5b24c --- /dev/null +++ b/docs/models/subscriptionreinstatedevent.md @@ -0,0 +1,23 @@ +# SubscriptionReinstatedEvent + +An event created by Polar when a canceled subscription is reinstated. + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `id` | *str* | :heavy_check_mark: | The ID of the object. | | +| `timestamp` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The timestamp of the event. | | +| `organization_id` | *str* | :heavy_check_mark: | The ID of the organization owning the event. | 1dbfc517-0bbf-4301-9ba8-555ca42b9737 | +| `customer_id` | *Nullable[str]* | :heavy_check_mark: | ID of the customer in your Polar organization associated with the event. | | +| `customer` | [Nullable[models.Customer]](../models/customer.md) | :heavy_check_mark: | The customer associated with the event. | | +| `external_customer_id` | *Nullable[str]* | :heavy_check_mark: | ID of the customer in your system associated with the event. | | +| `member_id` | *OptionalNullable[str]* | :heavy_minus_sign: | ID of the member within the customer's organization who performed the action inside B2B. | | +| `external_member_id` | *OptionalNullable[str]* | :heavy_minus_sign: | ID of the member in your system within the customer's organization who performed the action inside B2B. | | +| `child_count` | *Optional[int]* | :heavy_minus_sign: | Number of direct child events linked to this event. | | +| `parent_id` | *OptionalNullable[str]* | :heavy_minus_sign: | The ID of the parent event. | | +| `label` | *str* | :heavy_check_mark: | Human readable label of the event type. | | +| `source` | *Literal["system"]* | :heavy_check_mark: | The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API. | | +| `name` | *Literal["subscription.reinstated"]* | :heavy_check_mark: | The name of the event. | | +| `metadata` | [models.SubscriptionReinstatedMetadata](../models/subscriptionreinstatedmetadata.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/subscriptionreinstatedmetadata.md b/docs/models/subscriptionreinstatedmetadata.md new file mode 100644 index 00000000..73ce1a17 --- /dev/null +++ b/docs/models/subscriptionreinstatedmetadata.md @@ -0,0 +1,13 @@ +# SubscriptionReinstatedMetadata + + +## Fields + +| Field | Type | Required | Description | +| -------------------------- | -------------------------- | -------------------------- | -------------------------- | +| `subscription_id` | *str* | :heavy_check_mark: | N/A | +| `product_id` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `amount` | *Optional[int]* | :heavy_minus_sign: | N/A | +| `currency` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `recurring_interval` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `recurring_interval_count` | *Optional[int]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/systemevent.md b/docs/models/systemevent.md index 743d3340..3c599001 100644 --- a/docs/models/systemevent.md +++ b/docs/models/systemevent.md @@ -111,6 +111,12 @@ value: models.OrderPaidEvent = /* values here */ value: models.OrderRefundedEvent = /* values here */ ``` +### `models.OrderUnvoidedEvent` + +```python +value: models.OrderUnvoidedEvent = /* values here */ +``` + ### `models.OrderVoidedEvent` ```python @@ -165,6 +171,12 @@ value: models.SubscriptionProductUpdatedEvent = /* values here */ value: models.SubscriptionReactivatedEvent = /* values here */ ``` +### `models.SubscriptionReinstatedEvent` + +```python +value: models.SubscriptionReinstatedEvent = /* values here */ +``` + ### `models.SubscriptionResumedEvent` ```python diff --git a/docs/models/webhookdiscountcreatedpayload.md b/docs/models/webhookdiscountcreatedpayload.md new file mode 100644 index 00000000..fd6f3670 --- /dev/null +++ b/docs/models/webhookdiscountcreatedpayload.md @@ -0,0 +1,14 @@ +# WebhookDiscountCreatedPayload + +Sent when a new discount is created. + +**Discord & Slack support:** Basic + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `type` | *Literal["discount.created"]* | :heavy_check_mark: | N/A | discount.created | +| `timestamp` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | | +| `data` | [models.Discount](../models/discount.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/webhookdiscountdeletedpayload.md b/docs/models/webhookdiscountdeletedpayload.md new file mode 100644 index 00000000..8a168d5d --- /dev/null +++ b/docs/models/webhookdiscountdeletedpayload.md @@ -0,0 +1,14 @@ +# WebhookDiscountDeletedPayload + +Sent when a discount is deleted. + +**Discord & Slack support:** Basic + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `type` | *Literal["discount.deleted"]* | :heavy_check_mark: | N/A | discount.deleted | +| `timestamp` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | | +| `data` | [models.Discount](../models/discount.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/webhookdiscountupdatedpayload.md b/docs/models/webhookdiscountupdatedpayload.md new file mode 100644 index 00000000..853f0db9 --- /dev/null +++ b/docs/models/webhookdiscountupdatedpayload.md @@ -0,0 +1,14 @@ +# WebhookDiscountUpdatedPayload + +Sent when a discount is updated. + +**Discord & Slack support:** Basic + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `type` | *Literal["discount.updated"]* | :heavy_check_mark: | N/A | discount.updated | +| `timestamp` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | | +| `data` | [models.Discount](../models/discount.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/webhookeventtype.md b/docs/models/webhookeventtype.md index d429bca4..c0126c4a 100644 --- a/docs/models/webhookeventtype.md +++ b/docs/models/webhookeventtype.md @@ -27,6 +27,7 @@ | `SUBSCRIPTION_ACTIVE` | subscription.active | | `SUBSCRIPTION_CANCELED` | subscription.canceled | | `SUBSCRIPTION_UNCANCELED` | subscription.uncanceled | +| `SUBSCRIPTION_CYCLED` | subscription.cycled | | `SUBSCRIPTION_REVOKED` | subscription.revoked | | `SUBSCRIPTION_PAST_DUE` | subscription.past_due | | `SUBSCRIPTION_PAUSED` | subscription.paused | @@ -35,6 +36,9 @@ | `REFUND_UPDATED` | refund.updated | | `PRODUCT_CREATED` | product.created | | `PRODUCT_UPDATED` | product.updated | +| `DISCOUNT_CREATED` | discount.created | +| `DISCOUNT_UPDATED` | discount.updated | +| `DISCOUNT_DELETED` | discount.deleted | | `BENEFIT_CREATED` | benefit.created | | `BENEFIT_UPDATED` | benefit.updated | | `BENEFIT_GRANT_CREATED` | benefit_grant.created | diff --git a/docs/models/webhooksubscriptioncycledpayload.md b/docs/models/webhooksubscriptioncycledpayload.md new file mode 100644 index 00000000..02eebe9a --- /dev/null +++ b/docs/models/webhooksubscriptioncycledpayload.md @@ -0,0 +1,22 @@ +# WebhookSubscriptionCycledPayload + +Sent when a subscription enters a new billing period. + +The payload carries the new `current_period_start` and `current_period_end`. +It fires when the period rolls over, before the renewal order exists and +regardless of whether the renewal payment succeeds — listen to `order.paid` +if you need the payment. + +A trial converting to a paid subscription starts a new period, so it fires +there too. Read `status` to tell the two apart. + +**Discord & Slack support:** Basic + + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | +| `type` | *Literal["subscription.cycled"]* | :heavy_check_mark: | N/A | subscription.cycled | +| `timestamp` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | N/A | | +| `data` | [models.Subscription](../models/subscription.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/webhooksubscriptionupdatedpayload.md b/docs/models/webhooksubscriptionupdatedpayload.md index 3621ab19..09724ae5 100644 --- a/docs/models/webhooksubscriptionupdatedpayload.md +++ b/docs/models/webhooksubscriptionupdatedpayload.md @@ -4,7 +4,7 @@ Sent when a subscription is updated. This event fires for all changes to the sub If you want more specific events, you can listen to `subscription.active`, `subscription.canceled`, `subscription.past_due`, and `subscription.revoked`. -To listen specifically for renewals, you can listen to `order.created` events and check the `billing_reason` field. +To listen specifically for renewals, listen to `subscription.cycled`. **Discord & Slack support:** On cancellation, past due, and revocation. Renewals are skipped. diff --git a/pyproject.toml b/pyproject.toml index 60bba62a..0f997e10 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,7 @@ [project] name = "polar-sdk" -version = "0.32.0" +version = "0.32.1" 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 78a05afd..22ac49dd 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.32.0" +__version__: str = "0.32.1" __openapi_doc_version__: str = "2026-04" __gen_version__: str = "2.737.0" -__user_agent__: str = "speakeasy-sdk/python 0.32.0 2.737.0 2026-04 polar-sdk" +__user_agent__: str = "speakeasy-sdk/python 0.32.1 2.737.0 2026-04 polar-sdk" try: if __package__ is not None: diff --git a/src/polar_sdk/models/__init__.py b/src/polar_sdk/models/__init__.py index e271ba24..02fbdf70 100644 --- a/src/polar_sdk/models/__init__.py +++ b/src/polar_sdk/models/__init__.py @@ -2447,6 +2447,11 @@ from .ordersortproperty import OrderSortProperty from .orderstatus import OrderStatus from .ordersubscription import OrderSubscription, OrderSubscriptionTypedDict + from .orderunvoidedevent import OrderUnvoidedEvent, OrderUnvoidedEventTypedDict + from .orderunvoidedmetadata import ( + OrderUnvoidedMetadata, + OrderUnvoidedMetadataTypedDict, + ) from .orderupdate import OrderUpdate, OrderUpdateTypedDict from .ordervoidedevent import OrderVoidedEvent, OrderVoidedEventTypedDict from .ordervoidedmetadata import OrderVoidedMetadata, OrderVoidedMetadataTypedDict @@ -2860,6 +2865,14 @@ SubscriptionReactivatedMetadata, SubscriptionReactivatedMetadataTypedDict, ) + from .subscriptionreinstatedevent import ( + SubscriptionReinstatedEvent, + SubscriptionReinstatedEventTypedDict, + ) + from .subscriptionreinstatedmetadata import ( + SubscriptionReinstatedMetadata, + SubscriptionReinstatedMetadataTypedDict, + ) from .subscriptionresume import SubscriptionResume, SubscriptionResumeTypedDict from .subscriptionresumedevent import ( SubscriptionResumedEvent, @@ -3146,6 +3159,18 @@ WebhookCustomerUpdatedPayloadTypedDict, ) from .webhookdelivery import WebhookDelivery, WebhookDeliveryTypedDict + from .webhookdiscountcreatedpayload import ( + WebhookDiscountCreatedPayload, + WebhookDiscountCreatedPayloadTypedDict, + ) + from .webhookdiscountdeletedpayload import ( + WebhookDiscountDeletedPayload, + WebhookDiscountDeletedPayloadTypedDict, + ) + from .webhookdiscountupdatedpayload import ( + WebhookDiscountUpdatedPayload, + WebhookDiscountUpdatedPayloadTypedDict, + ) from .webhookendpoint import WebhookEndpoint, WebhookEndpointTypedDict from .webhookendpointcreate import ( WebhookEndpointCreate, @@ -3257,6 +3282,10 @@ WebhookSubscriptionCreatedPayload, WebhookSubscriptionCreatedPayloadTypedDict, ) + from .webhooksubscriptioncycledpayload import ( + WebhookSubscriptionCycledPayload, + WebhookSubscriptionCycledPayloadTypedDict, + ) from .webhooksubscriptionpastduepayload import ( WebhookSubscriptionPastDuePayload, WebhookSubscriptionPastDuePayloadTypedDict, @@ -5049,6 +5078,10 @@ "OrderSubscription", "OrderSubscriptionTypedDict", "OrderTypedDict", + "OrderUnvoidedEvent", + "OrderUnvoidedEventTypedDict", + "OrderUnvoidedMetadata", + "OrderUnvoidedMetadataTypedDict", "OrderUpdate", "OrderUpdateTypedDict", "OrderVoidedEvent", @@ -5453,6 +5486,10 @@ "SubscriptionReactivatedEventTypedDict", "SubscriptionReactivatedMetadata", "SubscriptionReactivatedMetadataTypedDict", + "SubscriptionReinstatedEvent", + "SubscriptionReinstatedEventTypedDict", + "SubscriptionReinstatedMetadata", + "SubscriptionReinstatedMetadataTypedDict", "SubscriptionResume", "SubscriptionResumeTypedDict", "SubscriptionResumedEvent", @@ -5593,6 +5630,12 @@ "WebhookCustomerUpdatedPayloadTypedDict", "WebhookDelivery", "WebhookDeliveryTypedDict", + "WebhookDiscountCreatedPayload", + "WebhookDiscountCreatedPayloadTypedDict", + "WebhookDiscountDeletedPayload", + "WebhookDiscountDeletedPayloadTypedDict", + "WebhookDiscountUpdatedPayload", + "WebhookDiscountUpdatedPayloadTypedDict", "WebhookEndpoint", "WebhookEndpointCreate", "WebhookEndpointCreateTypedDict", @@ -5633,6 +5676,8 @@ "WebhookSubscriptionCanceledPayloadTypedDict", "WebhookSubscriptionCreatedPayload", "WebhookSubscriptionCreatedPayloadTypedDict", + "WebhookSubscriptionCycledPayload", + "WebhookSubscriptionCycledPayloadTypedDict", "WebhookSubscriptionPastDuePayload", "WebhookSubscriptionPastDuePayloadTypedDict", "WebhookSubscriptionPausedPayload", @@ -7424,6 +7469,10 @@ "OrderStatus": ".orderstatus", "OrderSubscription": ".ordersubscription", "OrderSubscriptionTypedDict": ".ordersubscription", + "OrderUnvoidedEvent": ".orderunvoidedevent", + "OrderUnvoidedEventTypedDict": ".orderunvoidedevent", + "OrderUnvoidedMetadata": ".orderunvoidedmetadata", + "OrderUnvoidedMetadataTypedDict": ".orderunvoidedmetadata", "OrderUpdate": ".orderupdate", "OrderUpdateTypedDict": ".orderupdate", "OrderVoidedEvent": ".ordervoidedevent", @@ -7740,6 +7789,10 @@ "SubscriptionReactivatedEventTypedDict": ".subscriptionreactivatedevent", "SubscriptionReactivatedMetadata": ".subscriptionreactivatedmetadata", "SubscriptionReactivatedMetadataTypedDict": ".subscriptionreactivatedmetadata", + "SubscriptionReinstatedEvent": ".subscriptionreinstatedevent", + "SubscriptionReinstatedEventTypedDict": ".subscriptionreinstatedevent", + "SubscriptionReinstatedMetadata": ".subscriptionreinstatedmetadata", + "SubscriptionReinstatedMetadataTypedDict": ".subscriptionreinstatedmetadata", "SubscriptionResume": ".subscriptionresume", "SubscriptionResumeTypedDict": ".subscriptionresume", "SubscriptionResumedEvent": ".subscriptionresumedevent", @@ -7954,6 +8007,12 @@ "WebhookCustomerUpdatedPayloadTypedDict": ".webhookcustomerupdatedpayload", "WebhookDelivery": ".webhookdelivery", "WebhookDeliveryTypedDict": ".webhookdelivery", + "WebhookDiscountCreatedPayload": ".webhookdiscountcreatedpayload", + "WebhookDiscountCreatedPayloadTypedDict": ".webhookdiscountcreatedpayload", + "WebhookDiscountDeletedPayload": ".webhookdiscountdeletedpayload", + "WebhookDiscountDeletedPayloadTypedDict": ".webhookdiscountdeletedpayload", + "WebhookDiscountUpdatedPayload": ".webhookdiscountupdatedpayload", + "WebhookDiscountUpdatedPayloadTypedDict": ".webhookdiscountupdatedpayload", "WebhookEndpoint": ".webhookendpoint", "WebhookEndpointTypedDict": ".webhookendpoint", "WebhookEndpointCreate": ".webhookendpointcreate", @@ -8019,6 +8078,8 @@ "WebhookSubscriptionCanceledPayloadTypedDict": ".webhooksubscriptioncanceledpayload", "WebhookSubscriptionCreatedPayload": ".webhooksubscriptioncreatedpayload", "WebhookSubscriptionCreatedPayloadTypedDict": ".webhooksubscriptioncreatedpayload", + "WebhookSubscriptionCycledPayload": ".webhooksubscriptioncycledpayload", + "WebhookSubscriptionCycledPayloadTypedDict": ".webhooksubscriptioncycledpayload", "WebhookSubscriptionPastDuePayload": ".webhooksubscriptionpastduepayload", "WebhookSubscriptionPastDuePayloadTypedDict": ".webhooksubscriptionpastduepayload", "WebhookSubscriptionPausedPayload": ".webhooksubscriptionpausedpayload", diff --git a/src/polar_sdk/models/checkout.py b/src/polar_sdk/models/checkout.py index fda45665..e2b70985 100644 --- a/src/polar_sdk/models/checkout.py +++ b/src/polar_sdk/models/checkout.py @@ -182,6 +182,8 @@ class CheckoutTypedDict(TypedDict): customer_billing_name: Nullable[str] customer_billing_address: Nullable[AddressTypedDict] customer_tax_id: Nullable[str] + payment_method_type: Nullable[str] + r"""Payment method type selected by the customer in the checkout form, e.g. `card`, `apple_pay` or `upi`.""" payment_processor_metadata: Dict[str, str] billing_address_fields: CheckoutBillingAddressFieldsTypedDict trial_interval: Nullable[TrialInterval] @@ -340,6 +342,9 @@ class Checkout(BaseModel): customer_tax_id: Nullable[str] + payment_method_type: Nullable[str] + r"""Payment method type selected by the customer in the checkout form, e.g. `card`, `apple_pay` or `upi`.""" + payment_processor_metadata: Dict[str, str] billing_address_fields: CheckoutBillingAddressFields @@ -427,6 +432,7 @@ def serialize_model(self, handler): "customer_billing_address", "customer_tax_id", "locale", + "payment_method_type", "trial_interval", "trial_interval_count", "external_customer_id", diff --git a/src/polar_sdk/models/checkoutconfirmstripe.py b/src/polar_sdk/models/checkoutconfirmstripe.py index 59937ba6..93517ba1 100644 --- a/src/polar_sdk/models/checkoutconfirmstripe.py +++ b/src/polar_sdk/models/checkoutconfirmstripe.py @@ -43,6 +43,8 @@ class CheckoutConfirmStripeTypedDict(TypedDict): customer_billing_address: NotRequired[Nullable[AddressInputTypedDict]] customer_tax_id: NotRequired[Nullable[str]] locale: NotRequired[Nullable[str]] + payment_method_type: NotRequired[Nullable[str]] + r"""Payment method type selected by the customer in the checkout form, e.g. `card`, `apple_pay` or `upi`.""" discount_code: NotRequired[Nullable[str]] r"""Discount code to apply to the checkout.""" allow_trial: Nullable[Literal[False]] @@ -89,6 +91,9 @@ class CheckoutConfirmStripe(BaseModel): locale: OptionalNullable[str] = UNSET + payment_method_type: OptionalNullable[str] = UNSET + r"""Payment method type selected by the customer in the checkout form, e.g. `card`, `apple_pay` or `upi`.""" + discount_code: OptionalNullable[str] = UNSET r"""Discount code to apply to the checkout.""" @@ -118,6 +123,7 @@ def serialize_model(self, handler): "customer_billing_address", "customer_tax_id", "locale", + "payment_method_type", "discount_code", "allow_trial", "confirmation_token_id", @@ -134,6 +140,7 @@ def serialize_model(self, handler): "customer_billing_address", "customer_tax_id", "locale", + "payment_method_type", "discount_code", "allow_trial", "confirmation_token_id", diff --git a/src/polar_sdk/models/checkoutpublic.py b/src/polar_sdk/models/checkoutpublic.py index 322d2254..05a636c7 100644 --- a/src/polar_sdk/models/checkoutpublic.py +++ b/src/polar_sdk/models/checkoutpublic.py @@ -174,6 +174,8 @@ class CheckoutPublicTypedDict(TypedDict): customer_billing_name: Nullable[str] customer_billing_address: Nullable[AddressTypedDict] customer_tax_id: Nullable[str] + payment_method_type: Nullable[str] + r"""Payment method type selected by the customer in the checkout form, e.g. `card`, `apple_pay` or `upi`.""" payment_processor_metadata: Dict[str, str] billing_address_fields: CheckoutBillingAddressFieldsTypedDict products: List[CheckoutProductTypedDict] @@ -324,6 +326,9 @@ class CheckoutPublic(BaseModel): customer_tax_id: Nullable[str] + payment_method_type: Nullable[str] + r"""Payment method type selected by the customer in the checkout form, e.g. `card`, `apple_pay` or `upi`.""" + payment_processor_metadata: Dict[str, str] billing_address_fields: CheckoutBillingAddressFields @@ -400,6 +405,7 @@ def serialize_model(self, handler): "customer_billing_address", "customer_tax_id", "locale", + "payment_method_type", "product", "product_price", "prices", diff --git a/src/polar_sdk/models/checkoutpublicconfirmed.py b/src/polar_sdk/models/checkoutpublicconfirmed.py index 37399c2b..625231ab 100644 --- a/src/polar_sdk/models/checkoutpublicconfirmed.py +++ b/src/polar_sdk/models/checkoutpublicconfirmed.py @@ -179,6 +179,8 @@ class CheckoutPublicConfirmedTypedDict(TypedDict): customer_billing_name: Nullable[str] customer_billing_address: Nullable[AddressTypedDict] customer_tax_id: Nullable[str] + payment_method_type: Nullable[str] + r"""Payment method type selected by the customer in the checkout form, e.g. `card`, `apple_pay` or `upi`.""" payment_processor_metadata: Dict[str, str] billing_address_fields: CheckoutBillingAddressFieldsTypedDict products: List[CheckoutProductTypedDict] @@ -333,6 +335,9 @@ class CheckoutPublicConfirmed(BaseModel): customer_tax_id: Nullable[str] + payment_method_type: Nullable[str] + r"""Payment method type selected by the customer in the checkout form, e.g. `card`, `apple_pay` or `upi`.""" + payment_processor_metadata: Dict[str, str] billing_address_fields: CheckoutBillingAddressFields @@ -416,6 +421,7 @@ def serialize_model(self, handler): "customer_billing_address", "customer_tax_id", "locale", + "payment_method_type", "product", "product_price", "prices", diff --git a/src/polar_sdk/models/checkoutupdatepublic.py b/src/polar_sdk/models/checkoutupdatepublic.py index dc822b56..9a074584 100644 --- a/src/polar_sdk/models/checkoutupdatepublic.py +++ b/src/polar_sdk/models/checkoutupdatepublic.py @@ -43,6 +43,8 @@ class CheckoutUpdatePublicTypedDict(TypedDict): customer_billing_address: NotRequired[Nullable[AddressInputTypedDict]] customer_tax_id: NotRequired[Nullable[str]] locale: NotRequired[Nullable[str]] + payment_method_type: NotRequired[Nullable[str]] + r"""Payment method type selected by the customer in the checkout form, e.g. `card`, `apple_pay` or `upi`.""" discount_code: NotRequired[Nullable[str]] r"""Discount code to apply to the checkout.""" allow_trial: Nullable[Literal[False]] @@ -87,6 +89,9 @@ class CheckoutUpdatePublic(BaseModel): locale: OptionalNullable[str] = UNSET + payment_method_type: OptionalNullable[str] = UNSET + r"""Payment method type selected by the customer in the checkout form, e.g. `card`, `apple_pay` or `upi`.""" + discount_code: OptionalNullable[str] = UNSET r"""Discount code to apply to the checkout.""" @@ -113,6 +118,7 @@ def serialize_model(self, handler): "customer_billing_address", "customer_tax_id", "locale", + "payment_method_type", "discount_code", "allow_trial", ] @@ -128,6 +134,7 @@ def serialize_model(self, handler): "customer_billing_address", "customer_tax_id", "locale", + "payment_method_type", "discount_code", "allow_trial", ] diff --git a/src/polar_sdk/models/orderunvoidedevent.py b/src/polar_sdk/models/orderunvoidedevent.py new file mode 100644 index 00000000..6cc4643a --- /dev/null +++ b/src/polar_sdk/models/orderunvoidedevent.py @@ -0,0 +1,140 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from .customer import Customer, CustomerTypedDict +from .orderunvoidedmetadata import OrderUnvoidedMetadata, OrderUnvoidedMetadataTypedDict +from datetime import datetime +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 + + +class OrderUnvoidedEventTypedDict(TypedDict): + r"""An event created by Polar when an order is unvoided.""" + + id: str + r"""The ID of the object.""" + timestamp: datetime + r"""The timestamp of the event.""" + organization_id: str + r"""The ID of the organization owning the event.""" + customer_id: Nullable[str] + r"""ID of the customer in your Polar organization associated with the event.""" + customer: Nullable[CustomerTypedDict] + r"""The customer associated with the event.""" + external_customer_id: Nullable[str] + r"""ID of the customer in your system associated with the event.""" + label: str + r"""Human readable label of the event type.""" + metadata: OrderUnvoidedMetadataTypedDict + member_id: NotRequired[Nullable[str]] + r"""ID of the member within the customer's organization who performed the action inside B2B.""" + external_member_id: NotRequired[Nullable[str]] + r"""ID of the member in your system within the customer's organization who performed the action inside B2B.""" + child_count: NotRequired[int] + r"""Number of direct child events linked to this event.""" + parent_id: NotRequired[Nullable[str]] + r"""The ID of the parent event.""" + source: Literal["system"] + r"""The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API.""" + name: Literal["order.unvoided"] + r"""The name of the event.""" + + +class OrderUnvoidedEvent(BaseModel): + r"""An event created by Polar when an order is unvoided.""" + + id: str + r"""The ID of the object.""" + + timestamp: datetime + r"""The timestamp of the event.""" + + organization_id: str + r"""The ID of the organization owning the event.""" + + customer_id: Nullable[str] + r"""ID of the customer in your Polar organization associated with the event.""" + + customer: Nullable[Customer] + r"""The customer associated with the event.""" + + external_customer_id: Nullable[str] + r"""ID of the customer in your system associated with the event.""" + + label: str + r"""Human readable label of the event type.""" + + metadata: OrderUnvoidedMetadata + + member_id: OptionalNullable[str] = UNSET + r"""ID of the member within the customer's organization who performed the action inside B2B.""" + + external_member_id: OptionalNullable[str] = UNSET + r"""ID of the member in your system within the customer's organization who performed the action inside B2B.""" + + child_count: Optional[int] = 0 + r"""Number of direct child events linked to this event.""" + + parent_id: OptionalNullable[str] = UNSET + r"""The ID of the parent event.""" + + SOURCE: Annotated[ + Annotated[Literal["system"], AfterValidator(validate_const("system"))], + pydantic.Field(alias="source"), + ] = "system" + r"""The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API.""" + + NAME: Annotated[ + Annotated[ + Literal["order.unvoided"], AfterValidator(validate_const("order.unvoided")) + ], + pydantic.Field(alias="name"), + ] = "order.unvoided" + r"""The name of the event.""" + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "member_id", + "external_member_id", + "child_count", + "parent_id", + ] + nullable_fields = [ + "customer_id", + "customer", + "external_customer_id", + "member_id", + "external_member_id", + "parent_id", + ] + 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/orderunvoidedmetadata.py b/src/polar_sdk/models/orderunvoidedmetadata.py new file mode 100644 index 00000000..11e61d93 --- /dev/null +++ b/src/polar_sdk/models/orderunvoidedmetadata.py @@ -0,0 +1,19 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from polar_sdk.types import BaseModel +from typing_extensions import TypedDict + + +class OrderUnvoidedMetadataTypedDict(TypedDict): + order_id: str + amount: int + currency: str + + +class OrderUnvoidedMetadata(BaseModel): + order_id: str + + amount: int + + currency: str diff --git a/src/polar_sdk/models/subscriptionreinstatedevent.py b/src/polar_sdk/models/subscriptionreinstatedevent.py new file mode 100644 index 00000000..77212038 --- /dev/null +++ b/src/polar_sdk/models/subscriptionreinstatedevent.py @@ -0,0 +1,144 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from .customer import Customer, CustomerTypedDict +from .subscriptionreinstatedmetadata import ( + SubscriptionReinstatedMetadata, + SubscriptionReinstatedMetadataTypedDict, +) +from datetime import datetime +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 + + +class SubscriptionReinstatedEventTypedDict(TypedDict): + r"""An event created by Polar when a canceled subscription is reinstated.""" + + id: str + r"""The ID of the object.""" + timestamp: datetime + r"""The timestamp of the event.""" + organization_id: str + r"""The ID of the organization owning the event.""" + customer_id: Nullable[str] + r"""ID of the customer in your Polar organization associated with the event.""" + customer: Nullable[CustomerTypedDict] + r"""The customer associated with the event.""" + external_customer_id: Nullable[str] + r"""ID of the customer in your system associated with the event.""" + label: str + r"""Human readable label of the event type.""" + metadata: SubscriptionReinstatedMetadataTypedDict + member_id: NotRequired[Nullable[str]] + r"""ID of the member within the customer's organization who performed the action inside B2B.""" + external_member_id: NotRequired[Nullable[str]] + r"""ID of the member in your system within the customer's organization who performed the action inside B2B.""" + child_count: NotRequired[int] + r"""Number of direct child events linked to this event.""" + parent_id: NotRequired[Nullable[str]] + r"""The ID of the parent event.""" + source: Literal["system"] + r"""The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API.""" + name: Literal["subscription.reinstated"] + r"""The name of the event.""" + + +class SubscriptionReinstatedEvent(BaseModel): + r"""An event created by Polar when a canceled subscription is reinstated.""" + + id: str + r"""The ID of the object.""" + + timestamp: datetime + r"""The timestamp of the event.""" + + organization_id: str + r"""The ID of the organization owning the event.""" + + customer_id: Nullable[str] + r"""ID of the customer in your Polar organization associated with the event.""" + + customer: Nullable[Customer] + r"""The customer associated with the event.""" + + external_customer_id: Nullable[str] + r"""ID of the customer in your system associated with the event.""" + + label: str + r"""Human readable label of the event type.""" + + metadata: SubscriptionReinstatedMetadata + + member_id: OptionalNullable[str] = UNSET + r"""ID of the member within the customer's organization who performed the action inside B2B.""" + + external_member_id: OptionalNullable[str] = UNSET + r"""ID of the member in your system within the customer's organization who performed the action inside B2B.""" + + child_count: Optional[int] = 0 + r"""Number of direct child events linked to this event.""" + + parent_id: OptionalNullable[str] = UNSET + r"""The ID of the parent event.""" + + SOURCE: Annotated[ + Annotated[Literal["system"], AfterValidator(validate_const("system"))], + pydantic.Field(alias="source"), + ] = "system" + r"""The source of the event. `system` events are created by Polar. `user` events are the one you create through our ingestion API.""" + + NAME: Annotated[ + Annotated[ + Literal["subscription.reinstated"], + AfterValidator(validate_const("subscription.reinstated")), + ], + pydantic.Field(alias="name"), + ] = "subscription.reinstated" + r"""The name of the event.""" + + @model_serializer(mode="wrap") + def serialize_model(self, handler): + optional_fields = [ + "member_id", + "external_member_id", + "child_count", + "parent_id", + ] + nullable_fields = [ + "customer_id", + "customer", + "external_customer_id", + "member_id", + "external_member_id", + "parent_id", + ] + 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/subscriptionreinstatedmetadata.py b/src/polar_sdk/models/subscriptionreinstatedmetadata.py new file mode 100644 index 00000000..7ccbdc65 --- /dev/null +++ b/src/polar_sdk/models/subscriptionreinstatedmetadata.py @@ -0,0 +1,29 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from polar_sdk.types import BaseModel +from typing import Optional +from typing_extensions import NotRequired, TypedDict + + +class SubscriptionReinstatedMetadataTypedDict(TypedDict): + subscription_id: str + product_id: NotRequired[str] + amount: NotRequired[int] + currency: NotRequired[str] + recurring_interval: NotRequired[str] + recurring_interval_count: NotRequired[int] + + +class SubscriptionReinstatedMetadata(BaseModel): + subscription_id: str + + product_id: Optional[str] = None + + amount: Optional[int] = None + + currency: Optional[str] = None + + recurring_interval: Optional[str] = None + + recurring_interval_count: Optional[int] = None diff --git a/src/polar_sdk/models/systemevent.py b/src/polar_sdk/models/systemevent.py index 765c1b5f..73b81f02 100644 --- a/src/polar_sdk/models/systemevent.py +++ b/src/polar_sdk/models/systemevent.py @@ -28,6 +28,7 @@ from .meterresetevent import MeterResetEvent, MeterResetEventTypedDict from .orderpaidevent import OrderPaidEvent, OrderPaidEventTypedDict from .orderrefundedevent import OrderRefundedEvent, OrderRefundedEventTypedDict +from .orderunvoidedevent import OrderUnvoidedEvent, OrderUnvoidedEventTypedDict from .ordervoidedevent import OrderVoidedEvent, OrderVoidedEventTypedDict from .subscriptionbillingperiodupdatedevent import ( SubscriptionBillingPeriodUpdatedEvent, @@ -61,6 +62,10 @@ SubscriptionReactivatedEvent, SubscriptionReactivatedEventTypedDict, ) +from .subscriptionreinstatedevent import ( + SubscriptionReinstatedEvent, + SubscriptionReinstatedEventTypedDict, +) from .subscriptionresumedevent import ( SubscriptionResumedEvent, SubscriptionResumedEventTypedDict, @@ -107,6 +112,7 @@ SubscriptionRevokedEventTypedDict, SubscriptionPastDueEventTypedDict, SubscriptionReactivatedEventTypedDict, + SubscriptionReinstatedEventTypedDict, SubscriptionPausedEventTypedDict, SubscriptionResumedEventTypedDict, SubscriptionUncanceledEventTypedDict, @@ -117,6 +123,7 @@ OrderPaidEventTypedDict, OrderRefundedEventTypedDict, OrderVoidedEventTypedDict, + OrderUnvoidedEventTypedDict, CheckoutCreatedEventTypedDict, CustomerCreatedEventTypedDict, CustomerUpdatedEventTypedDict, @@ -151,6 +158,7 @@ Annotated[MeterResetEvent, Tag("meter.reset")], Annotated[OrderPaidEvent, Tag("order.paid")], Annotated[OrderRefundedEvent, Tag("order.refunded")], + Annotated[OrderUnvoidedEvent, Tag("order.unvoided")], Annotated[OrderVoidedEvent, Tag("order.voided")], Annotated[ SubscriptionBillingPeriodUpdatedEvent, @@ -163,6 +171,7 @@ Annotated[SubscriptionPausedEvent, Tag("subscription.paused")], Annotated[SubscriptionProductUpdatedEvent, Tag("subscription.product_updated")], Annotated[SubscriptionReactivatedEvent, Tag("subscription.reactivated")], + Annotated[SubscriptionReinstatedEvent, Tag("subscription.reinstated")], Annotated[SubscriptionResumedEvent, Tag("subscription.resumed")], Annotated[SubscriptionRevokedEvent, Tag("subscription.revoked")], Annotated[SubscriptionSeatsUpdatedEvent, Tag("subscription.seats_updated")], diff --git a/src/polar_sdk/models/webhookdiscountcreatedpayload.py b/src/polar_sdk/models/webhookdiscountcreatedpayload.py new file mode 100644 index 00000000..ea1ac6d5 --- /dev/null +++ b/src/polar_sdk/models/webhookdiscountcreatedpayload.py @@ -0,0 +1,41 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from .discount import Discount, DiscountTypedDict +from datetime import datetime +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 WebhookDiscountCreatedPayloadTypedDict(TypedDict): + r"""Sent when a new discount is created. + + **Discord & Slack support:** Basic + """ + + timestamp: datetime + data: DiscountTypedDict + type: Literal["discount.created"] + + +class WebhookDiscountCreatedPayload(BaseModel): + r"""Sent when a new discount is created. + + **Discord & Slack support:** Basic + """ + + timestamp: datetime + + data: Discount + + TYPE: Annotated[ + Annotated[ + Literal["discount.created"], + AfterValidator(validate_const("discount.created")), + ], + pydantic.Field(alias="type"), + ] = "discount.created" diff --git a/src/polar_sdk/models/webhookdiscountdeletedpayload.py b/src/polar_sdk/models/webhookdiscountdeletedpayload.py new file mode 100644 index 00000000..5738b4d8 --- /dev/null +++ b/src/polar_sdk/models/webhookdiscountdeletedpayload.py @@ -0,0 +1,41 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from .discount import Discount, DiscountTypedDict +from datetime import datetime +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 WebhookDiscountDeletedPayloadTypedDict(TypedDict): + r"""Sent when a discount is deleted. + + **Discord & Slack support:** Basic + """ + + timestamp: datetime + data: DiscountTypedDict + type: Literal["discount.deleted"] + + +class WebhookDiscountDeletedPayload(BaseModel): + r"""Sent when a discount is deleted. + + **Discord & Slack support:** Basic + """ + + timestamp: datetime + + data: Discount + + TYPE: Annotated[ + Annotated[ + Literal["discount.deleted"], + AfterValidator(validate_const("discount.deleted")), + ], + pydantic.Field(alias="type"), + ] = "discount.deleted" diff --git a/src/polar_sdk/models/webhookdiscountupdatedpayload.py b/src/polar_sdk/models/webhookdiscountupdatedpayload.py new file mode 100644 index 00000000..3bd92fce --- /dev/null +++ b/src/polar_sdk/models/webhookdiscountupdatedpayload.py @@ -0,0 +1,41 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from .discount import Discount, DiscountTypedDict +from datetime import datetime +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 WebhookDiscountUpdatedPayloadTypedDict(TypedDict): + r"""Sent when a discount is updated. + + **Discord & Slack support:** Basic + """ + + timestamp: datetime + data: DiscountTypedDict + type: Literal["discount.updated"] + + +class WebhookDiscountUpdatedPayload(BaseModel): + r"""Sent when a discount is updated. + + **Discord & Slack support:** Basic + """ + + timestamp: datetime + + data: Discount + + TYPE: Annotated[ + Annotated[ + Literal["discount.updated"], + AfterValidator(validate_const("discount.updated")), + ], + pydantic.Field(alias="type"), + ] = "discount.updated" diff --git a/src/polar_sdk/models/webhookeventtype.py b/src/polar_sdk/models/webhookeventtype.py index 92f1ff15..7cb91491 100644 --- a/src/polar_sdk/models/webhookeventtype.py +++ b/src/polar_sdk/models/webhookeventtype.py @@ -27,6 +27,7 @@ class WebhookEventType(str, Enum): SUBSCRIPTION_ACTIVE = "subscription.active" SUBSCRIPTION_CANCELED = "subscription.canceled" SUBSCRIPTION_UNCANCELED = "subscription.uncanceled" + SUBSCRIPTION_CYCLED = "subscription.cycled" SUBSCRIPTION_REVOKED = "subscription.revoked" SUBSCRIPTION_PAST_DUE = "subscription.past_due" SUBSCRIPTION_PAUSED = "subscription.paused" @@ -35,6 +36,9 @@ class WebhookEventType(str, Enum): REFUND_UPDATED = "refund.updated" PRODUCT_CREATED = "product.created" PRODUCT_UPDATED = "product.updated" + DISCOUNT_CREATED = "discount.created" + DISCOUNT_UPDATED = "discount.updated" + DISCOUNT_DELETED = "discount.deleted" BENEFIT_CREATED = "benefit.created" BENEFIT_UPDATED = "benefit.updated" BENEFIT_GRANT_CREATED = "benefit_grant.created" diff --git a/src/polar_sdk/models/webhooksubscriptioncycledpayload.py b/src/polar_sdk/models/webhooksubscriptioncycledpayload.py new file mode 100644 index 00000000..6a035b1c --- /dev/null +++ b/src/polar_sdk/models/webhooksubscriptioncycledpayload.py @@ -0,0 +1,57 @@ +"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" + +from __future__ import annotations +from .subscription import Subscription, SubscriptionTypedDict +from datetime import datetime +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 WebhookSubscriptionCycledPayloadTypedDict(TypedDict): + r"""Sent when a subscription enters a new billing period. + + The payload carries the new `current_period_start` and `current_period_end`. + It fires when the period rolls over, before the renewal order exists and + regardless of whether the renewal payment succeeds — listen to `order.paid` + if you need the payment. + + A trial converting to a paid subscription starts a new period, so it fires + there too. Read `status` to tell the two apart. + + **Discord & Slack support:** Basic + """ + + timestamp: datetime + data: SubscriptionTypedDict + type: Literal["subscription.cycled"] + + +class WebhookSubscriptionCycledPayload(BaseModel): + r"""Sent when a subscription enters a new billing period. + + The payload carries the new `current_period_start` and `current_period_end`. + It fires when the period rolls over, before the renewal order exists and + regardless of whether the renewal payment succeeds — listen to `order.paid` + if you need the payment. + + A trial converting to a paid subscription starts a new period, so it fires + there too. Read `status` to tell the two apart. + + **Discord & Slack support:** Basic + """ + + timestamp: datetime + + data: Subscription + + TYPE: Annotated[ + Annotated[ + Literal["subscription.cycled"], + AfterValidator(validate_const("subscription.cycled")), + ], + pydantic.Field(alias="type"), + ] = "subscription.cycled" diff --git a/src/polar_sdk/models/webhooksubscriptionupdatedpayload.py b/src/polar_sdk/models/webhooksubscriptionupdatedpayload.py index 47955731..2820bfd3 100644 --- a/src/polar_sdk/models/webhooksubscriptionupdatedpayload.py +++ b/src/polar_sdk/models/webhooksubscriptionupdatedpayload.py @@ -16,7 +16,7 @@ class WebhookSubscriptionUpdatedPayloadTypedDict(TypedDict): If you want more specific events, you can listen to `subscription.active`, `subscription.canceled`, `subscription.past_due`, and `subscription.revoked`. - To listen specifically for renewals, you can listen to `order.created` events and check the `billing_reason` field. + To listen specifically for renewals, listen to `subscription.cycled`. **Discord & Slack support:** On cancellation, past due, and revocation. Renewals are skipped. """ @@ -31,7 +31,7 @@ class WebhookSubscriptionUpdatedPayload(BaseModel): If you want more specific events, you can listen to `subscription.active`, `subscription.canceled`, `subscription.past_due`, and `subscription.revoked`. - To listen specifically for renewals, you can listen to `order.created` events and check the `billing_reason` field. + To listen specifically for renewals, listen to `subscription.cycled`. **Discord & Slack support:** On cancellation, past due, and revocation. Renewals are skipped. """ From f1fbd8d1d4d90d615b7b1315a039fdf708745fe9 Mon Sep 17 00:00:00 2001 From: "speakeasy-github[bot]" <128539517+speakeasy-github[bot]@users.noreply.github.com> Date: Tue, 28 Jul 2026 00:33:01 +0000 Subject: [PATCH 2/2] empty commit to trigger [run-tests] workflow