@flexprice/sdk 2.1.25 → 2.1.30
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/sdk/models/add-line-item-request.md +24 -0
- package/docs/sdk/models/addon-cadence.md +1 -3
- package/docs/sdk/models/alert-settings.md +7 -6
- package/docs/sdk/models/alert-threshold-type.md +17 -0
- package/docs/sdk/models/billing-period-behaviour.md +17 -0
- package/docs/sdk/models/billing-period-config.md +18 -0
- package/docs/sdk/models/changed-invoice-status.md +0 -2
- package/docs/sdk/models/changed-invoice.md +7 -7
- package/docs/sdk/models/checkout-payment-block.md +17 -0
- package/docs/sdk/models/checkout-payment-provider-config.md +6 -5
- package/docs/sdk/models/checkout-payment-provider.md +3 -1
- package/docs/sdk/models/checkout-session-response.md +25 -30
- package/docs/sdk/models/collection-method.md +1 -3
- package/docs/sdk/models/create-checkout-session-request.md +1 -1
- package/docs/sdk/models/create-credit-note-request.md +2 -1
- package/docs/sdk/models/create-customer-request.md +1 -0
- package/docs/sdk/models/create-invoice-request.md +0 -1
- package/docs/sdk/models/create-price-request.md +1 -0
- package/docs/sdk/models/create-subscription-request.md +41 -40
- package/docs/sdk/models/create-task-request.md +27 -0
- package/docs/sdk/models/create-tax-association-request.md +1 -0
- package/docs/sdk/models/create-tax-rate-request.md +1 -2
- package/docs/sdk/models/credit-grant-application-response.md +1 -1
- package/docs/sdk/models/custom-currency-line-item.md +18 -0
- package/docs/sdk/models/custom-currency.md +22 -0
- package/docs/sdk/models/customer-response.md +1 -0
- package/docs/sdk/models/customer.md +1 -0
- package/docs/sdk/models/entitlement-response.md +1 -1
- package/docs/sdk/models/entity-change-behaviour.md +2 -2
- package/docs/sdk/models/entity-change-policy.md +4 -4
- package/docs/sdk/models/entity-change-result.md +6 -6
- package/docs/sdk/models/execute-invoice-modify-request-request.md +21 -0
- package/docs/sdk/models/execute-invoice-modify-request.md +18 -0
- package/docs/sdk/models/finalize-credit-note-request.md +15 -0
- package/docs/sdk/models/get-refund-request.md +17 -0
- package/docs/sdk/models/get-subscription-schedule-request.md +2 -2
- package/docs/sdk/models/global-custom-field.md +16 -0
- package/docs/sdk/models/invoice-line-item-response.md +1 -0
- package/docs/sdk/models/invoice-modify-line-item-action.md +15 -0
- package/docs/sdk/models/invoice-modify-line-item-params.md +21 -0
- package/docs/sdk/models/invoice-modify-response.md +126 -0
- package/docs/sdk/models/invoice-modify-type.md +15 -0
- package/docs/sdk/models/invoice-response.md +3 -0
- package/docs/sdk/models/invoice-sync-settings.md +9 -4
- package/docs/sdk/models/list-addon-associations-response.md +146 -0
- package/docs/sdk/models/list-refunds-request.md +23 -0
- package/docs/sdk/models/list-refunds-response.md +16 -0
- package/docs/sdk/models/list-subscription-schedules-request.md +2 -2
- package/docs/sdk/models/list-usage-records-response.md +16 -0
- package/docs/sdk/models/metadata-custom-field-source.md +17 -0
- package/docs/sdk/models/metadata-custom-field.md +17 -0
- package/docs/sdk/models/meter-aggregation.md +8 -8
- package/docs/sdk/models/on-pending-schedule-policy.md +15 -0
- package/docs/sdk/models/override-line-item-request.md +1 -0
- package/docs/sdk/models/payment-gateway-type.md +2 -2
- package/docs/sdk/models/plan-price-sync-status-response.md +17 -0
- package/docs/sdk/models/plan-response.md +1 -0
- package/docs/sdk/models/price-feature-response.md +15 -0
- package/docs/sdk/models/price-price.md +1 -0
- package/docs/sdk/models/price-response.md +2 -0
- package/docs/sdk/models/process-credit-note-request.md +4 -3
- package/docs/sdk/models/refund-destination.md +17 -0
- package/docs/sdk/models/refund-reason.md +17 -0
- package/docs/sdk/models/refund-response.md +45 -0
- package/docs/sdk/models/refund-status.md +17 -0
- package/docs/sdk/models/refund-target.md +15 -0
- package/docs/sdk/models/remove-user-request.md +17 -0
- package/docs/sdk/models/retry-refund-request.md +17 -0
- package/docs/sdk/models/s3-job-config.md +1 -0
- package/docs/sdk/models/secret-provider.md +2 -2
- package/docs/sdk/models/storage-export-config.md +20 -0
- package/docs/sdk/models/subscription-change-billing-period-result.md +18 -0
- package/docs/sdk/models/subscription-change-conflict-policies.md +15 -0
- package/docs/sdk/models/subscription-change-entity-type.md +17 -0
- package/docs/sdk/models/subscription-change-v2-request.md +11 -8
- package/docs/sdk/models/subscription-change-v2-response.md +16 -14
- package/docs/sdk/models/subscription-price-create-request.md +1 -0
- package/docs/sdk/models/sync-config.md +1 -1
- package/docs/sdk/models/tax-applied-response.md +1 -0
- package/docs/sdk/models/tax-association-response.md +1 -0
- package/docs/sdk/models/tax-association-update-request.md +6 -5
- package/docs/sdk/models/tax-behavior.md +17 -0
- package/docs/sdk/models/tax-exemption-reason-code.md +17 -0
- package/docs/sdk/models/tax-exemption-summary.md +16 -0
- package/docs/sdk/models/tax-rate-override.md +8 -7
- package/docs/sdk/models/tax-rate-response.md +0 -1
- package/docs/sdk/models/tax-rate-type.md +2 -4
- package/docs/sdk/models/tax-summary.md +18 -0
- package/docs/sdk/models/tax-treatment.md +17 -0
- package/docs/sdk/models/update-customer-request.md +1 -0
- package/docs/sdk/models/update-line-item-request.md +20 -0
- package/docs/sdk/models/update-payment-request.md +13 -12
- package/docs/sdk/models/update-price-request.md +1 -0
- package/docs/sdk/models/update-subscription-line-item-request.md +1 -0
- package/docs/sdk/models/usage-record-filter-order.md +15 -0
- package/docs/sdk/models/usage-record-filter.md +31 -0
- package/docs/sdk/models/usage-record-response.md +33 -0
- package/docs/sdk/models/{checkout-jsonb-checkout-provider-result.md → usage-record-sync-entry.md} +11 -10
- package/docs/sdk/models/webhook-dto-coupon-application.md +28 -0
- package/docs/sdk/models/webhook-dto-coupon-association.md +21 -0
- package/docs/sdk/models/webhook-dto-invoice-line-item.md +16 -1
- package/docs/sdk/models/webhook-dto-invoice-webhook-payload.md +5 -116
- package/docs/sdk/models/webhook-dto-invoice.md +12 -0
- package/docs/sdk/models/webhook-dto-meter.md +19 -0
- package/docs/sdk/models/webhook-dto-plan.md +20 -0
- package/docs/sdk/models/webhook-dto-price.md +36 -0
- package/docs/sdk/models/webhook-dto-refund-webhook-payload.md +16 -0
- package/docs/sdk/models/webhook-dto-refund.md +32 -0
- package/docs/sdk/models/webhook-dto-subscription-line-item.md +34 -0
- package/docs/sdk/models/webhook-dto-subscription-webhook-payload.md +1 -0
- package/docs/sdk/models/webhook-dto-subscription.md +29 -25
- package/docs/sdk/models/webhook-dto-tax-applied.md +23 -0
- package/docs/sdk/models/webhook-dto-tax-rate.md +20 -0
- package/docs/sdk/models/webhook-dto-wallet-webhook-payload.md +1 -0
- package/docs/sdk/models/webhook-event-name.md +1 -1
- package/docs/sdks/creditnotes/README.md +1 -0
- package/docs/sdks/invoices/README.md +77 -0
- package/docs/sdks/prices/README.md +1 -1
- package/docs/sdks/refunds/README.md +222 -0
- package/docs/sdks/subscriptions/README.md +241 -239
- package/docs/sdks/tasks/README.md +84 -0
- package/docs/sdks/usagerecords/README.md +78 -0
- package/docs/sdks/users/README.md +72 -0
- package/docs/sdks/webhookevents/README.md +214 -7
- package/esm/funcs/credit-notes-process-credit-note.d.ts +1 -1
- package/esm/funcs/credit-notes-process-credit-note.d.ts.map +1 -1
- package/esm/funcs/credit-notes-process-credit-note.js +8 -6
- package/esm/funcs/credit-notes-process-credit-note.js.map +1 -1
- package/esm/funcs/invoices-execute-invoice-modify.d.ts +17 -0
- package/esm/funcs/invoices-execute-invoice-modify.d.ts.map +1 -0
- package/esm/funcs/invoices-execute-invoice-modify.js +93 -0
- package/esm/funcs/invoices-execute-invoice-modify.js.map +1 -0
- package/esm/funcs/prices-get-price-by-lookup-key.js +1 -1
- package/esm/funcs/prices-get-price-by-lookup-key.js.map +1 -1
- package/esm/funcs/refunds-get-refund.d.ts +17 -0
- package/esm/funcs/refunds-get-refund.d.ts.map +1 -0
- package/esm/funcs/refunds-get-refund.js +91 -0
- package/esm/funcs/refunds-get-refund.js.map +1 -0
- package/esm/funcs/refunds-list-refunds.d.ts +17 -0
- package/esm/funcs/refunds-list-refunds.d.ts.map +1 -0
- package/esm/funcs/refunds-list-refunds.js +95 -0
- package/esm/funcs/refunds-list-refunds.js.map +1 -0
- package/esm/funcs/refunds-retry-refund.d.ts +17 -0
- package/esm/funcs/refunds-retry-refund.d.ts.map +1 -0
- package/esm/funcs/refunds-retry-refund.js +91 -0
- package/esm/funcs/refunds-retry-refund.js.map +1 -0
- package/esm/funcs/subscriptions-cancel-subscription-schedule.js +1 -1
- package/esm/funcs/subscriptions-cancel-subscription-schedule.js.map +1 -1
- package/esm/funcs/subscriptions-execute-subscription-plan-change-v2.d.ts +3 -1
- package/esm/funcs/subscriptions-execute-subscription-plan-change-v2.d.ts.map +1 -1
- package/esm/funcs/subscriptions-execute-subscription-plan-change-v2.js +3 -1
- package/esm/funcs/subscriptions-execute-subscription-plan-change-v2.js.map +1 -1
- package/esm/funcs/subscriptions-get-subscription-addon-associations.d.ts +1 -1
- package/esm/funcs/subscriptions-get-subscription-addon-associations.d.ts.map +1 -1
- package/esm/funcs/subscriptions-get-subscription-addon-associations.js +1 -1
- package/esm/funcs/subscriptions-get-subscription-addon-associations.js.map +1 -1
- package/esm/funcs/subscriptions-get-subscription-schedule.d.ts +1 -1
- package/esm/funcs/subscriptions-get-subscription-schedule.d.ts.map +1 -1
- package/esm/funcs/subscriptions-get-subscription-schedule.js +6 -6
- package/esm/funcs/subscriptions-get-subscription-schedule.js.map +1 -1
- package/esm/funcs/subscriptions-list-all-subscription-schedules.js +1 -1
- package/esm/funcs/subscriptions-list-all-subscription-schedules.js.map +1 -1
- package/esm/funcs/subscriptions-list-subscription-schedules.d.ts +1 -1
- package/esm/funcs/subscriptions-list-subscription-schedules.d.ts.map +1 -1
- package/esm/funcs/subscriptions-list-subscription-schedules.js +6 -6
- package/esm/funcs/subscriptions-list-subscription-schedules.js.map +1 -1
- package/esm/funcs/tasks-create-task.d.ts +17 -0
- package/esm/funcs/tasks-create-task.d.ts.map +1 -0
- package/esm/funcs/tasks-create-task.js +83 -0
- package/esm/funcs/tasks-create-task.js.map +1 -0
- package/esm/funcs/usage-records-post-usage-records-search.d.ts +17 -0
- package/esm/funcs/usage-records-post-usage-records-search.d.ts.map +1 -0
- package/esm/funcs/usage-records-post-usage-records-search.js +83 -0
- package/esm/funcs/usage-records-post-usage-records-search.js.map +1 -0
- package/esm/funcs/users-remove-user.d.ts +17 -0
- package/esm/funcs/users-remove-user.d.ts.map +1 -0
- package/esm/funcs/users-remove-user.js +91 -0
- package/esm/funcs/users-remove-user.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-invoice-communication-triggered.d.ts +1 -1
- package/esm/funcs/webhook-events-post-webhook-events-invoice-communication-triggered.js +1 -1
- package/esm/funcs/webhook-events-post-webhook-events-invoice-create-drafted.d.ts +1 -1
- package/esm/funcs/webhook-events-post-webhook-events-invoice-create-drafted.js +1 -1
- package/esm/funcs/webhook-events-post-webhook-events-invoice-payment-overdue.d.ts +1 -1
- package/esm/funcs/webhook-events-post-webhook-events-invoice-payment-overdue.js +1 -1
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update-finalized.d.ts +1 -1
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update-finalized.js +1 -1
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update-payment.d.ts +1 -1
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update-payment.js +1 -1
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update-voided.d.ts +1 -1
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update-voided.js +1 -1
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update.d.ts +1 -1
- package/esm/funcs/webhook-events-post-webhook-events-invoice-update.js +1 -1
- package/esm/funcs/webhook-events-post-webhook-events-refund-created.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-refund-created.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-refund-created.js +69 -0
- package/esm/funcs/webhook-events-post-webhook-events-refund-created.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-refund-failed.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-refund-failed.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-refund-failed.js +69 -0
- package/esm/funcs/webhook-events-post-webhook-events-refund-failed.js.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-refund-succeeded.d.ts +17 -0
- package/esm/funcs/webhook-events-post-webhook-events-refund-succeeded.d.ts.map +1 -0
- package/esm/funcs/webhook-events-post-webhook-events-refund-succeeded.js +69 -0
- package/esm/funcs/webhook-events-post-webhook-events-refund-succeeded.js.map +1 -0
- package/esm/lib/config.d.ts +3 -3
- package/esm/lib/config.js +3 -3
- package/esm/lib/encodings.d.ts +10 -9
- package/esm/lib/encodings.d.ts.map +1 -1
- package/esm/lib/encodings.js +29 -13
- package/esm/lib/encodings.js.map +1 -1
- package/esm/sdk/credit-notes.d.ts +1 -1
- package/esm/sdk/credit-notes.d.ts.map +1 -1
- package/esm/sdk/credit-notes.js +2 -2
- package/esm/sdk/credit-notes.js.map +1 -1
- package/esm/sdk/invoices.d.ts +7 -0
- package/esm/sdk/invoices.d.ts.map +1 -1
- package/esm/sdk/invoices.js +10 -0
- package/esm/sdk/invoices.js.map +1 -1
- package/esm/sdk/models/add-addon-params.d.ts +0 -5
- package/esm/sdk/models/add-addon-params.d.ts.map +1 -1
- package/esm/sdk/models/add-addon-params.js +1 -15
- package/esm/sdk/models/add-addon-params.js.map +1 -1
- package/esm/sdk/models/add-addon-ref.d.ts +0 -5
- package/esm/sdk/models/add-addon-ref.d.ts.map +1 -1
- package/esm/sdk/models/add-addon-ref.js +2 -23
- package/esm/sdk/models/add-addon-ref.js.map +1 -1
- package/esm/sdk/models/add-line-item-request.d.ts +22 -0
- package/esm/sdk/models/add-line-item-request.d.ts.map +1 -0
- package/esm/sdk/models/add-line-item-request.js +24 -0
- package/esm/sdk/models/add-line-item-request.js.map +1 -0
- package/esm/sdk/models/addon-cadence.d.ts +3 -5
- package/esm/sdk/models/addon-cadence.d.ts.map +1 -1
- package/esm/sdk/models/addon-cadence.js +3 -4
- package/esm/sdk/models/addon-cadence.js.map +1 -1
- package/esm/sdk/models/alert-settings.d.ts +3 -0
- package/esm/sdk/models/alert-settings.d.ts.map +1 -1
- package/esm/sdk/models/alert-settings.js +5 -0
- package/esm/sdk/models/alert-settings.js.map +1 -1
- package/esm/sdk/models/alert-threshold-type.d.ts +12 -0
- package/esm/sdk/models/alert-threshold-type.d.ts.map +1 -0
- package/esm/sdk/models/alert-threshold-type.js +13 -0
- package/esm/sdk/models/alert-threshold-type.js.map +1 -0
- package/esm/sdk/models/billing-period-behaviour.d.ts +13 -0
- package/esm/sdk/models/billing-period-behaviour.d.ts.map +1 -0
- package/esm/sdk/models/billing-period-behaviour.js +14 -0
- package/esm/sdk/models/billing-period-behaviour.js.map +1 -0
- package/esm/sdk/models/billing-period-config.d.ts +20 -0
- package/esm/sdk/models/billing-period-config.d.ts.map +1 -0
- package/esm/sdk/models/billing-period-config.js +25 -0
- package/esm/sdk/models/billing-period-config.js.map +1 -0
- package/esm/sdk/models/changed-invoice-status.d.ts +0 -6
- package/esm/sdk/models/changed-invoice-status.d.ts.map +1 -1
- package/esm/sdk/models/changed-invoice-status.js +0 -3
- package/esm/sdk/models/changed-invoice-status.js.map +1 -1
- package/esm/sdk/models/changed-invoice.d.ts +0 -3
- package/esm/sdk/models/changed-invoice.d.ts.map +1 -1
- package/esm/sdk/models/changed-invoice.js.map +1 -1
- package/esm/sdk/models/checkout-payment-block.d.ts +13 -0
- package/esm/sdk/models/checkout-payment-block.d.ts.map +1 -0
- package/esm/sdk/models/checkout-payment-block.js +17 -0
- package/esm/sdk/models/checkout-payment-block.js.map +1 -0
- package/esm/sdk/models/checkout-payment-provider-config.d.ts +9 -0
- package/esm/sdk/models/checkout-payment-provider-config.d.ts.map +1 -1
- package/esm/sdk/models/checkout-payment-provider-config.js +2 -0
- package/esm/sdk/models/checkout-payment-provider-config.js.map +1 -1
- package/esm/sdk/models/checkout-payment-provider.d.ts +5 -4
- package/esm/sdk/models/checkout-payment-provider.d.ts.map +1 -1
- package/esm/sdk/models/checkout-payment-provider.js +4 -3
- package/esm/sdk/models/checkout-payment-provider.js.map +1 -1
- package/esm/sdk/models/checkout-session-response.d.ts +23 -39
- package/esm/sdk/models/checkout-session-response.d.ts.map +1 -1
- package/esm/sdk/models/checkout-session-response.js +6 -20
- package/esm/sdk/models/checkout-session-response.js.map +1 -1
- package/esm/sdk/models/collection-method.d.ts +3 -5
- package/esm/sdk/models/collection-method.d.ts.map +1 -1
- package/esm/sdk/models/collection-method.js +2 -4
- package/esm/sdk/models/collection-method.js.map +1 -1
- package/esm/sdk/models/create-credit-note-request.d.ts +3 -0
- package/esm/sdk/models/create-credit-note-request.d.ts.map +1 -1
- package/esm/sdk/models/create-credit-note-request.js +3 -0
- package/esm/sdk/models/create-credit-note-request.js.map +1 -1
- package/esm/sdk/models/create-customer-request.d.ts +3 -0
- package/esm/sdk/models/create-customer-request.d.ts.map +1 -1
- package/esm/sdk/models/create-customer-request.js +3 -0
- package/esm/sdk/models/create-customer-request.js.map +1 -1
- package/esm/sdk/models/create-invoice-request.d.ts +0 -6
- package/esm/sdk/models/create-invoice-request.d.ts.map +1 -1
- package/esm/sdk/models/create-invoice-request.js +0 -3
- package/esm/sdk/models/create-invoice-request.js.map +1 -1
- package/esm/sdk/models/create-price-request.d.ts +3 -0
- package/esm/sdk/models/create-price-request.d.ts.map +1 -1
- package/esm/sdk/models/create-price-request.js +3 -0
- package/esm/sdk/models/create-price-request.js.map +1 -1
- package/esm/sdk/models/create-subscription-params.d.ts +0 -5
- package/esm/sdk/models/create-subscription-params.d.ts.map +1 -1
- package/esm/sdk/models/create-subscription-params.js +1 -26
- package/esm/sdk/models/create-subscription-params.js.map +1 -1
- package/esm/sdk/models/create-subscription-request.d.ts +15 -0
- package/esm/sdk/models/create-subscription-request.d.ts.map +1 -1
- package/esm/sdk/models/create-subscription-request.js +2 -0
- package/esm/sdk/models/create-subscription-request.js.map +1 -1
- package/esm/sdk/models/create-task-request.d.ts +31 -0
- package/esm/sdk/models/create-task-request.d.ts.map +1 -0
- package/esm/sdk/models/create-task-request.js +31 -0
- package/esm/sdk/models/create-task-request.js.map +1 -0
- package/esm/sdk/models/create-tax-association-request.d.ts +3 -0
- package/esm/sdk/models/create-tax-association-request.d.ts.map +1 -1
- package/esm/sdk/models/create-tax-association-request.js +3 -0
- package/esm/sdk/models/create-tax-association-request.js.map +1 -1
- package/esm/sdk/models/create-tax-rate-request.d.ts +1 -6
- package/esm/sdk/models/create-tax-rate-request.d.ts.map +1 -1
- package/esm/sdk/models/create-tax-rate-request.js +0 -2
- package/esm/sdk/models/create-tax-rate-request.js.map +1 -1
- package/esm/sdk/models/credit-grant-application-response.d.ts +1 -1
- package/esm/sdk/models/credit-grant-application-response.js +1 -1
- package/esm/sdk/models/custom-currency-line-item.d.ts +13 -0
- package/esm/sdk/models/custom-currency-line-item.d.ts.map +1 -0
- package/esm/sdk/models/custom-currency-line-item.js +24 -0
- package/esm/sdk/models/custom-currency-line-item.js.map +1 -0
- package/esm/sdk/models/custom-currency.d.ts +20 -0
- package/esm/sdk/models/custom-currency.d.ts.map +1 -0
- package/esm/sdk/models/custom-currency.js +29 -0
- package/esm/sdk/models/custom-currency.js.map +1 -0
- package/esm/sdk/models/customer-response.d.ts +2 -0
- package/esm/sdk/models/customer-response.d.ts.map +1 -1
- package/esm/sdk/models/customer-response.js +3 -0
- package/esm/sdk/models/customer-response.js.map +1 -1
- package/esm/sdk/models/customer.d.ts +2 -0
- package/esm/sdk/models/customer.d.ts.map +1 -1
- package/esm/sdk/models/customer.js +3 -0
- package/esm/sdk/models/customer.js.map +1 -1
- package/esm/sdk/models/entitlement-response.d.ts +1 -1
- package/esm/sdk/models/entitlement-response.js +1 -1
- package/esm/sdk/models/entity-change-behaviour.d.ts +1 -0
- package/esm/sdk/models/entity-change-behaviour.d.ts.map +1 -1
- package/esm/sdk/models/entity-change-behaviour.js +1 -0
- package/esm/sdk/models/entity-change-behaviour.js.map +1 -1
- package/esm/sdk/models/entity-change-policy.d.ts +3 -0
- package/esm/sdk/models/entity-change-policy.d.ts.map +1 -1
- package/esm/sdk/models/entity-change-policy.js.map +1 -1
- package/esm/sdk/models/entity-change-result.d.ts +2 -2
- package/esm/sdk/models/entity-change-result.d.ts.map +1 -1
- package/esm/sdk/models/entity-change-result.js +2 -2
- package/esm/sdk/models/entity-change-result.js.map +1 -1
- package/esm/sdk/models/entity-type.d.ts +2 -0
- package/esm/sdk/models/entity-type.d.ts.map +1 -1
- package/esm/sdk/models/entity-type.js +2 -0
- package/esm/sdk/models/entity-type.js.map +1 -1
- package/esm/sdk/models/execute-invoice-modify-op.d.ts +21 -0
- package/esm/sdk/models/execute-invoice-modify-op.d.ts.map +1 -0
- package/esm/sdk/models/execute-invoice-modify-op.js +14 -0
- package/esm/sdk/models/execute-invoice-modify-op.js.map +1 -0
- package/esm/sdk/models/execute-invoice-modify-request.d.ts +16 -0
- package/esm/sdk/models/execute-invoice-modify-request.d.ts.map +1 -0
- package/esm/sdk/models/execute-invoice-modify-request.js +20 -0
- package/esm/sdk/models/execute-invoice-modify-request.js.map +1 -0
- package/esm/sdk/models/file-type.d.ts +2 -0
- package/esm/sdk/models/file-type.d.ts.map +1 -1
- package/esm/sdk/models/file-type.js +2 -0
- package/esm/sdk/models/file-type.js.map +1 -1
- package/esm/sdk/models/finalize-credit-note-request.d.ts +13 -0
- package/esm/sdk/models/finalize-credit-note-request.d.ts.map +1 -0
- package/esm/sdk/models/finalize-credit-note-request.js +18 -0
- package/esm/sdk/models/finalize-credit-note-request.js.map +1 -0
- package/esm/sdk/models/get-refund-op.d.ts +15 -0
- package/esm/sdk/models/get-refund-op.d.ts.map +1 -0
- package/esm/sdk/models/get-refund-op.js +12 -0
- package/esm/sdk/models/get-refund-op.js.map +1 -0
- package/esm/sdk/models/get-subscription-schedule-op.d.ts +2 -2
- package/esm/sdk/models/get-subscription-schedule-op.d.ts.map +1 -1
- package/esm/sdk/models/get-subscription-schedule-op.js +8 -3
- package/esm/sdk/models/get-subscription-schedule-op.js.map +1 -1
- package/esm/sdk/models/global-custom-field.d.ts +11 -0
- package/esm/sdk/models/global-custom-field.d.ts.map +1 -0
- package/esm/sdk/models/global-custom-field.js +15 -0
- package/esm/sdk/models/global-custom-field.js.map +1 -0
- package/esm/sdk/models/index.d.ts +56 -6
- package/esm/sdk/models/index.d.ts.map +1 -1
- package/esm/sdk/models/index.js +56 -6
- package/esm/sdk/models/index.js.map +1 -1
- package/esm/sdk/models/invoice-line-item-response.d.ts +2 -0
- package/esm/sdk/models/invoice-line-item-response.d.ts.map +1 -1
- package/esm/sdk/models/invoice-line-item-response.js +3 -0
- package/esm/sdk/models/invoice-line-item-response.js.map +1 -1
- package/esm/sdk/models/invoice-modify-line-item-action.d.ts +11 -0
- package/esm/sdk/models/invoice-modify-line-item-action.d.ts.map +1 -0
- package/esm/sdk/models/invoice-modify-line-item-action.js +12 -0
- package/esm/sdk/models/invoice-modify-line-item-action.js.map +1 -0
- package/esm/sdk/models/invoice-modify-line-item-params.d.ts +32 -0
- package/esm/sdk/models/invoice-modify-line-item-params.d.ts.map +1 -0
- package/esm/sdk/models/invoice-modify-line-item-params.js +25 -0
- package/esm/sdk/models/invoice-modify-line-item-params.js.map +1 -0
- package/esm/sdk/models/invoice-modify-response.d.ts +11 -0
- package/esm/sdk/models/invoice-modify-response.d.ts.map +1 -0
- package/esm/sdk/models/invoice-modify-response.js +15 -0
- package/esm/sdk/models/invoice-modify-response.js.map +1 -0
- package/esm/sdk/models/invoice-modify-type.d.ts +9 -0
- package/esm/sdk/models/invoice-modify-type.d.ts.map +1 -0
- package/esm/sdk/models/invoice-modify-type.js +10 -0
- package/esm/sdk/models/invoice-modify-type.js.map +1 -0
- package/esm/sdk/models/invoice-response.d.ts +6 -0
- package/esm/sdk/models/invoice-response.d.ts.map +1 -1
- package/esm/sdk/models/invoice-response.js +9 -0
- package/esm/sdk/models/invoice-response.js.map +1 -1
- package/esm/sdk/models/invoice-sync-settings.d.ts +34 -0
- package/esm/sdk/models/invoice-sync-settings.d.ts.map +1 -1
- package/esm/sdk/models/invoice-sync-settings.js +12 -0
- package/esm/sdk/models/invoice-sync-settings.js.map +1 -1
- package/esm/sdk/models/list-addon-associations-response.d.ts +13 -0
- package/esm/sdk/models/list-addon-associations-response.d.ts.map +1 -0
- package/esm/sdk/models/list-addon-associations-response.js +17 -0
- package/esm/sdk/models/list-addon-associations-response.js.map +1 -0
- package/esm/sdk/models/list-refunds-op.d.ts +55 -0
- package/esm/sdk/models/list-refunds-op.d.ts.map +1 -0
- package/esm/sdk/models/list-refunds-op.js +30 -0
- package/esm/sdk/models/list-refunds-op.js.map +1 -0
- package/esm/sdk/models/list-refunds-response.d.ts +13 -0
- package/esm/sdk/models/list-refunds-response.d.ts.map +1 -0
- package/esm/sdk/models/list-refunds-response.js +17 -0
- package/esm/sdk/models/list-refunds-response.js.map +1 -0
- package/esm/sdk/models/list-subscription-schedules-op.d.ts +2 -2
- package/esm/sdk/models/list-subscription-schedules-op.d.ts.map +1 -1
- package/esm/sdk/models/list-subscription-schedules-op.js +3 -8
- package/esm/sdk/models/list-subscription-schedules-op.js.map +1 -1
- package/esm/sdk/models/list-usage-records-response.d.ts +13 -0
- package/esm/sdk/models/list-usage-records-response.d.ts.map +1 -0
- package/esm/sdk/models/list-usage-records-response.js +17 -0
- package/esm/sdk/models/list-usage-records-response.js.map +1 -0
- package/esm/sdk/models/metadata-custom-field-source.d.ts +10 -0
- package/esm/sdk/models/metadata-custom-field-source.d.ts.map +1 -0
- package/esm/sdk/models/metadata-custom-field-source.js +11 -0
- package/esm/sdk/models/metadata-custom-field-source.js.map +1 -0
- package/esm/sdk/models/metadata-custom-field.d.ts +13 -0
- package/esm/sdk/models/metadata-custom-field.d.ts.map +1 -0
- package/esm/sdk/models/metadata-custom-field.js +22 -0
- package/esm/sdk/models/metadata-custom-field.js.map +1 -0
- package/esm/sdk/models/meter-aggregation.d.ts +2 -1
- package/esm/sdk/models/meter-aggregation.d.ts.map +1 -1
- package/esm/sdk/models/meter-aggregation.js.map +1 -1
- package/esm/sdk/models/modify-subscription-line-item.d.ts +0 -5
- package/esm/sdk/models/modify-subscription-line-item.d.ts.map +1 -1
- package/esm/sdk/models/modify-subscription-line-item.js +0 -16
- package/esm/sdk/models/modify-subscription-line-item.js.map +1 -1
- package/esm/sdk/models/modify-subscription-params.d.ts +0 -5
- package/esm/sdk/models/modify-subscription-params.d.ts.map +1 -1
- package/esm/sdk/models/modify-subscription-params.js +1 -16
- package/esm/sdk/models/modify-subscription-params.js.map +1 -1
- package/esm/sdk/models/on-pending-schedule-policy.d.ts +10 -0
- package/esm/sdk/models/on-pending-schedule-policy.d.ts.map +1 -0
- package/esm/sdk/models/on-pending-schedule-policy.js +11 -0
- package/esm/sdk/models/on-pending-schedule-policy.js.map +1 -0
- package/esm/sdk/models/override-line-item-request.d.ts +3 -0
- package/esm/sdk/models/override-line-item-request.d.ts.map +1 -1
- package/esm/sdk/models/override-line-item-request.js +3 -0
- package/esm/sdk/models/override-line-item-request.js.map +1 -1
- package/esm/sdk/models/payment-gateway-type.d.ts +1 -0
- package/esm/sdk/models/payment-gateway-type.d.ts.map +1 -1
- package/esm/sdk/models/payment-gateway-type.js +1 -0
- package/esm/sdk/models/payment-gateway-type.js.map +1 -1
- package/esm/sdk/models/plan-price-sync-status-response.d.ts +12 -0
- package/esm/sdk/models/plan-price-sync-status-response.d.ts.map +1 -0
- package/esm/sdk/models/plan-price-sync-status-response.js +22 -0
- package/esm/sdk/models/plan-price-sync-status-response.js.map +1 -0
- package/esm/sdk/models/plan-response.d.ts +2 -0
- package/esm/sdk/models/plan-response.d.ts.map +1 -1
- package/esm/sdk/models/plan-response.js +3 -0
- package/esm/sdk/models/plan-response.js.map +1 -1
- package/esm/sdk/models/price-feature-response.d.ts +11 -0
- package/esm/sdk/models/price-feature-response.d.ts.map +1 -0
- package/esm/sdk/models/price-feature-response.js +20 -0
- package/esm/sdk/models/price-feature-response.js.map +1 -0
- package/esm/sdk/models/price-price.d.ts +2 -0
- package/esm/sdk/models/price-price.d.ts.map +1 -1
- package/esm/sdk/models/price-price.js +3 -0
- package/esm/sdk/models/price-price.js.map +1 -1
- package/esm/sdk/models/price-response.d.ts +4 -0
- package/esm/sdk/models/price-response.d.ts.map +1 -1
- package/esm/sdk/models/price-response.js +5 -0
- package/esm/sdk/models/price-response.js.map +1 -1
- package/esm/sdk/models/process-credit-note-op.d.ts +6 -0
- package/esm/sdk/models/process-credit-note-op.d.ts.map +1 -1
- package/esm/sdk/models/process-credit-note-op.js +2 -0
- package/esm/sdk/models/process-credit-note-op.js.map +1 -1
- package/esm/sdk/models/refund-destination.d.ts +11 -0
- package/esm/sdk/models/refund-destination.d.ts.map +1 -0
- package/esm/sdk/models/refund-destination.js +12 -0
- package/esm/sdk/models/refund-destination.js.map +1 -0
- package/esm/sdk/models/refund-reason.d.ts +14 -0
- package/esm/sdk/models/refund-reason.d.ts.map +1 -0
- package/esm/sdk/models/refund-reason.js +15 -0
- package/esm/sdk/models/refund-reason.js.map +1 -0
- package/esm/sdk/models/refund-response.d.ts +48 -0
- package/esm/sdk/models/refund-response.d.ts.map +1 -0
- package/esm/sdk/models/refund-response.js +77 -0
- package/esm/sdk/models/refund-response.js.map +1 -0
- package/esm/sdk/models/refund-status.d.ts +13 -0
- package/esm/sdk/models/refund-status.d.ts.map +1 -0
- package/esm/sdk/models/refund-status.js +14 -0
- package/esm/sdk/models/refund-status.js.map +1 -0
- package/esm/sdk/models/refund-target.d.ts +10 -0
- package/esm/sdk/models/refund-target.d.ts.map +1 -0
- package/esm/sdk/models/refund-target.js +12 -0
- package/esm/sdk/models/refund-target.js.map +1 -0
- package/esm/sdk/models/remove-user-op.d.ts +15 -0
- package/esm/sdk/models/remove-user-op.d.ts.map +1 -0
- package/esm/sdk/models/remove-user-op.js +12 -0
- package/esm/sdk/models/remove-user-op.js.map +1 -0
- package/esm/sdk/models/retry-refund-op.d.ts +15 -0
- package/esm/sdk/models/retry-refund-op.d.ts.map +1 -0
- package/esm/sdk/models/retry-refund-op.js +12 -0
- package/esm/sdk/models/retry-refund-op.js.map +1 -0
- package/esm/sdk/models/s3-job-config.d.ts +3 -0
- package/esm/sdk/models/s3-job-config.d.ts.map +1 -1
- package/esm/sdk/models/s3-job-config.js +3 -0
- package/esm/sdk/models/s3-job-config.js.map +1 -1
- package/esm/sdk/models/secret-provider.d.ts +1 -0
- package/esm/sdk/models/secret-provider.d.ts.map +1 -1
- package/esm/sdk/models/secret-provider.js +1 -0
- package/esm/sdk/models/secret-provider.js.map +1 -1
- package/esm/sdk/models/{s3-export-config.d.ts → storage-export-config.d.ts} +8 -8
- package/esm/sdk/models/storage-export-config.d.ts.map +1 -0
- package/esm/sdk/models/{s3-export-config.js → storage-export-config.js} +4 -4
- package/esm/sdk/models/storage-export-config.js.map +1 -0
- package/esm/sdk/models/subscription-change-billing-period-result.d.ts +14 -0
- package/esm/sdk/models/subscription-change-billing-period-result.d.ts.map +1 -0
- package/esm/sdk/models/subscription-change-billing-period-result.js +25 -0
- package/esm/sdk/models/subscription-change-billing-period-result.js.map +1 -0
- package/esm/sdk/models/subscription-change-conflict-policies.d.ts +13 -0
- package/esm/sdk/models/subscription-change-conflict-policies.d.ts.map +1 -0
- package/esm/sdk/models/subscription-change-conflict-policies.js +18 -0
- package/esm/sdk/models/subscription-change-conflict-policies.js.map +1 -0
- package/esm/sdk/models/subscription-change-entity-type.d.ts +13 -0
- package/esm/sdk/models/subscription-change-entity-type.d.ts.map +1 -0
- package/esm/sdk/models/subscription-change-entity-type.js +14 -0
- package/esm/sdk/models/subscription-change-entity-type.js.map +1 -0
- package/esm/sdk/models/subscription-change-v2-request.d.ts +9 -0
- package/esm/sdk/models/subscription-change-v2-request.d.ts.map +1 -1
- package/esm/sdk/models/subscription-change-v2-request.js +9 -0
- package/esm/sdk/models/subscription-change-v2-request.js.map +1 -1
- package/esm/sdk/models/subscription-change-v2-response.d.ts +9 -0
- package/esm/sdk/models/subscription-change-v2-response.d.ts.map +1 -1
- package/esm/sdk/models/subscription-change-v2-response.js +5 -0
- package/esm/sdk/models/subscription-change-v2-response.js.map +1 -1
- package/esm/sdk/models/subscription-price-create-request.d.ts +3 -0
- package/esm/sdk/models/subscription-price-create-request.d.ts.map +1 -1
- package/esm/sdk/models/subscription-price-create-request.js +3 -0
- package/esm/sdk/models/subscription-price-create-request.js.map +1 -1
- package/esm/sdk/models/sync-config.d.ts +2 -2
- package/esm/sdk/models/sync-config.d.ts.map +1 -1
- package/esm/sdk/models/sync-config.js +2 -2
- package/esm/sdk/models/sync-config.js.map +1 -1
- package/esm/sdk/models/task-type.d.ts +2 -0
- package/esm/sdk/models/task-type.d.ts.map +1 -1
- package/esm/sdk/models/task-type.js +2 -0
- package/esm/sdk/models/task-type.js.map +1 -1
- package/esm/sdk/models/tax-applied-response.d.ts +2 -0
- package/esm/sdk/models/tax-applied-response.d.ts.map +1 -1
- package/esm/sdk/models/tax-applied-response.js +3 -0
- package/esm/sdk/models/tax-applied-response.js.map +1 -1
- package/esm/sdk/models/tax-association-response.d.ts +2 -0
- package/esm/sdk/models/tax-association-response.d.ts.map +1 -1
- package/esm/sdk/models/tax-association-response.js +3 -0
- package/esm/sdk/models/tax-association-response.js.map +1 -1
- package/esm/sdk/models/tax-association-update-request.d.ts +3 -0
- package/esm/sdk/models/tax-association-update-request.d.ts.map +1 -1
- package/esm/sdk/models/tax-association-update-request.js +3 -0
- package/esm/sdk/models/tax-association-update-request.js.map +1 -1
- package/esm/sdk/models/tax-behavior.d.ts +12 -0
- package/esm/sdk/models/tax-behavior.d.ts.map +1 -0
- package/esm/sdk/models/tax-behavior.js +13 -0
- package/esm/sdk/models/tax-behavior.js.map +1 -0
- package/esm/sdk/models/tax-exemption-reason-code.d.ts +10 -0
- package/esm/sdk/models/tax-exemption-reason-code.d.ts.map +1 -0
- package/esm/sdk/models/tax-exemption-reason-code.js +11 -0
- package/esm/sdk/models/tax-exemption-reason-code.js.map +1 -0
- package/esm/sdk/models/tax-exemption-summary.d.ts +12 -0
- package/esm/sdk/models/tax-exemption-summary.d.ts.map +1 -0
- package/esm/sdk/models/tax-exemption-summary.js +21 -0
- package/esm/sdk/models/tax-exemption-summary.js.map +1 -0
- package/esm/sdk/models/tax-rate-override.d.ts +3 -0
- package/esm/sdk/models/tax-rate-override.d.ts.map +1 -1
- package/esm/sdk/models/tax-rate-override.js +3 -0
- package/esm/sdk/models/tax-rate-override.js.map +1 -1
- package/esm/sdk/models/tax-rate-response.d.ts +0 -26
- package/esm/sdk/models/tax-rate-response.d.ts.map +1 -1
- package/esm/sdk/models/tax-rate-response.js +4 -42
- package/esm/sdk/models/tax-rate-response.js.map +1 -1
- package/esm/sdk/models/tax-rate-type.d.ts +4 -5
- package/esm/sdk/models/tax-rate-type.d.ts.map +1 -1
- package/esm/sdk/models/tax-rate-type.js +4 -4
- package/esm/sdk/models/tax-rate-type.js.map +1 -1
- package/esm/sdk/models/tax-summary.d.ts +14 -0
- package/esm/sdk/models/tax-summary.d.ts.map +1 -0
- package/esm/sdk/models/tax-summary.js +26 -0
- package/esm/sdk/models/tax-summary.js.map +1 -0
- package/esm/sdk/models/tax-treatment.d.ts +12 -0
- package/esm/sdk/models/tax-treatment.d.ts.map +1 -0
- package/esm/sdk/models/tax-treatment.js +13 -0
- package/esm/sdk/models/tax-treatment.js.map +1 -0
- package/esm/sdk/models/update-customer-request.d.ts +3 -0
- package/esm/sdk/models/update-customer-request.d.ts.map +1 -1
- package/esm/sdk/models/update-customer-request.js +3 -0
- package/esm/sdk/models/update-customer-request.js.map +1 -1
- package/esm/sdk/models/update-line-item-request.d.ts +22 -0
- package/esm/sdk/models/update-line-item-request.d.ts.map +1 -0
- package/esm/sdk/models/update-line-item-request.js +24 -0
- package/esm/sdk/models/update-line-item-request.js.map +1 -0
- package/esm/sdk/models/update-payment-request.d.ts +8 -0
- package/esm/sdk/models/update-payment-request.d.ts.map +1 -1
- package/esm/sdk/models/update-payment-request.js +2 -0
- package/esm/sdk/models/update-payment-request.js.map +1 -1
- package/esm/sdk/models/update-price-request.d.ts +3 -0
- package/esm/sdk/models/update-price-request.d.ts.map +1 -1
- package/esm/sdk/models/update-price-request.js +3 -0
- package/esm/sdk/models/update-price-request.js.map +1 -1
- package/esm/sdk/models/update-subscription-line-item-request.d.ts +3 -0
- package/esm/sdk/models/update-subscription-line-item-request.d.ts.map +1 -1
- package/esm/sdk/models/update-subscription-line-item-request.js +3 -0
- package/esm/sdk/models/update-subscription-line-item-request.js.map +1 -1
- package/esm/sdk/models/usage-record-filter.d.ts +67 -0
- package/esm/sdk/models/usage-record-filter.d.ts.map +1 -0
- package/esm/sdk/models/usage-record-filter.js +49 -0
- package/esm/sdk/models/usage-record-filter.js.map +1 -0
- package/esm/sdk/models/usage-record-response.d.ts +32 -0
- package/esm/sdk/models/usage-record-response.d.ts.map +1 -0
- package/esm/sdk/models/usage-record-response.js +50 -0
- package/esm/sdk/models/usage-record-response.js.map +1 -0
- package/esm/sdk/models/usage-record-sync-entry.d.ts +32 -0
- package/esm/sdk/models/usage-record-sync-entry.d.ts.map +1 -0
- package/esm/sdk/models/usage-record-sync-entry.js +28 -0
- package/esm/sdk/models/usage-record-sync-entry.js.map +1 -0
- package/esm/sdk/models/wallet-topup-params.d.ts +0 -5
- package/esm/sdk/models/wallet-topup-params.d.ts.map +1 -1
- package/esm/sdk/models/wallet-topup-params.js +0 -15
- package/esm/sdk/models/wallet-topup-params.js.map +1 -1
- package/esm/sdk/models/webhook-dto-coupon-application.d.ts +28 -0
- package/esm/sdk/models/webhook-dto-coupon-application.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-coupon-application.js +43 -0
- package/esm/sdk/models/webhook-dto-coupon-application.js.map +1 -0
- package/esm/sdk/models/webhook-dto-coupon-association.d.ts +18 -0
- package/esm/sdk/models/webhook-dto-coupon-association.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-coupon-association.js +29 -0
- package/esm/sdk/models/webhook-dto-coupon-association.js.map +1 -0
- package/esm/sdk/models/webhook-dto-invoice-line-item.d.ts +18 -0
- package/esm/sdk/models/webhook-dto-invoice-line-item.d.ts.map +1 -1
- package/esm/sdk/models/webhook-dto-invoice-line-item.js +29 -0
- package/esm/sdk/models/webhook-dto-invoice-line-item.js.map +1 -1
- package/esm/sdk/models/webhook-dto-invoice-webhook-payload.d.ts +2 -2
- package/esm/sdk/models/webhook-dto-invoice-webhook-payload.d.ts.map +1 -1
- package/esm/sdk/models/webhook-dto-invoice-webhook-payload.js +2 -2
- package/esm/sdk/models/webhook-dto-invoice-webhook-payload.js.map +1 -1
- package/esm/sdk/models/webhook-dto-invoice.d.ts +15 -0
- package/esm/sdk/models/webhook-dto-invoice.d.ts.map +1 -1
- package/esm/sdk/models/webhook-dto-invoice.js +25 -0
- package/esm/sdk/models/webhook-dto-invoice.js.map +1 -1
- package/esm/sdk/models/webhook-dto-meter.d.ts +16 -0
- package/esm/sdk/models/webhook-dto-meter.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-meter.js +26 -0
- package/esm/sdk/models/webhook-dto-meter.js.map +1 -0
- package/esm/sdk/models/webhook-dto-plan.d.ts +18 -0
- package/esm/sdk/models/webhook-dto-plan.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-plan.js +25 -0
- package/esm/sdk/models/webhook-dto-plan.js.map +1 -0
- package/esm/sdk/models/webhook-dto-price.d.ts +42 -0
- package/esm/sdk/models/webhook-dto-price.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-price.js +62 -0
- package/esm/sdk/models/webhook-dto-price.js.map +1 -0
- package/esm/sdk/models/webhook-dto-refund-webhook-payload.d.ts +13 -0
- package/esm/sdk/models/webhook-dto-refund-webhook-payload.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-refund-webhook-payload.js +22 -0
- package/esm/sdk/models/webhook-dto-refund-webhook-payload.js.map +1 -0
- package/esm/sdk/models/webhook-dto-refund.d.ts +32 -0
- package/esm/sdk/models/webhook-dto-refund.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-refund.js +51 -0
- package/esm/sdk/models/webhook-dto-refund.js.map +1 -0
- package/esm/sdk/models/webhook-dto-subscription-line-item.d.ts +36 -0
- package/esm/sdk/models/webhook-dto-subscription-line-item.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-subscription-line-item.js +57 -0
- package/esm/sdk/models/webhook-dto-subscription-line-item.js.map +1 -0
- package/esm/sdk/models/webhook-dto-subscription-webhook-payload.d.ts +2 -0
- package/esm/sdk/models/webhook-dto-subscription-webhook-payload.d.ts.map +1 -1
- package/esm/sdk/models/webhook-dto-subscription-webhook-payload.js +2 -0
- package/esm/sdk/models/webhook-dto-subscription-webhook-payload.js.map +1 -1
- package/esm/sdk/models/webhook-dto-subscription.d.ts +7 -0
- package/esm/sdk/models/webhook-dto-subscription.d.ts.map +1 -1
- package/esm/sdk/models/webhook-dto-subscription.js +10 -0
- package/esm/sdk/models/webhook-dto-subscription.js.map +1 -1
- package/esm/sdk/models/webhook-dto-tax-applied.d.ts +22 -0
- package/esm/sdk/models/webhook-dto-tax-applied.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-tax-applied.js +34 -0
- package/esm/sdk/models/webhook-dto-tax-applied.js.map +1 -0
- package/esm/sdk/models/webhook-dto-tax-rate.d.ts +16 -0
- package/esm/sdk/models/webhook-dto-tax-rate.d.ts.map +1 -0
- package/esm/sdk/models/webhook-dto-tax-rate.js +26 -0
- package/esm/sdk/models/webhook-dto-tax-rate.js.map +1 -0
- package/esm/sdk/models/webhook-dto-wallet-webhook-payload.d.ts +2 -0
- package/esm/sdk/models/webhook-dto-wallet-webhook-payload.d.ts.map +1 -1
- package/esm/sdk/models/webhook-dto-wallet-webhook-payload.js +2 -0
- package/esm/sdk/models/webhook-dto-wallet-webhook-payload.js.map +1 -1
- package/esm/sdk/models/webhook-event-name.d.ts +3 -0
- package/esm/sdk/models/webhook-event-name.d.ts.map +1 -1
- package/esm/sdk/models/webhook-event-name.js +3 -0
- package/esm/sdk/models/webhook-event-name.js.map +1 -1
- package/esm/sdk/refunds.d.ts +26 -0
- package/esm/sdk/refunds.d.ts.map +1 -0
- package/esm/sdk/refunds.js +38 -0
- package/esm/sdk/refunds.js.map +1 -0
- package/esm/sdk/sdk.d.ts +6 -0
- package/esm/sdk/sdk.d.ts.map +1 -1
- package/esm/sdk/sdk.js +10 -0
- package/esm/sdk/sdk.js.map +1 -1
- package/esm/sdk/subscriptions.d.ts +31 -29
- package/esm/sdk/subscriptions.d.ts.map +1 -1
- package/esm/sdk/subscriptions.js +38 -36
- package/esm/sdk/subscriptions.js.map +1 -1
- package/esm/sdk/tasks.d.ts +7 -0
- package/esm/sdk/tasks.d.ts.map +1 -1
- package/esm/sdk/tasks.js +10 -0
- package/esm/sdk/tasks.js.map +1 -1
- package/esm/sdk/usage-records.d.ts +12 -0
- package/esm/sdk/usage-records.d.ts.map +1 -0
- package/esm/sdk/usage-records.js +18 -0
- package/esm/sdk/usage-records.js.map +1 -0
- package/esm/sdk/users.d.ts +7 -0
- package/esm/sdk/users.d.ts.map +1 -1
- package/esm/sdk/users.js +10 -0
- package/esm/sdk/users.js.map +1 -1
- package/esm/sdk/webhook-events.d.ts +28 -7
- package/esm/sdk/webhook-events.d.ts.map +1 -1
- package/esm/sdk/webhook-events.js +37 -7
- package/esm/sdk/webhook-events.js.map +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/credit-notes-process-credit-note.ts +8 -3
- package/src/funcs/invoices-execute-invoice-modify.ts +187 -0
- package/src/funcs/prices-get-price-by-lookup-key.ts +1 -1
- package/src/funcs/refunds-get-refund.ts +181 -0
- package/src/funcs/refunds-list-refunds.ts +189 -0
- package/src/funcs/refunds-retry-refund.ts +181 -0
- package/src/funcs/subscriptions-cancel-subscription-schedule.ts +1 -1
- package/src/funcs/subscriptions-execute-subscription-plan-change-v2.ts +3 -1
- package/src/funcs/subscriptions-get-subscription-addon-associations.ts +4 -4
- package/src/funcs/subscriptions-get-subscription-schedule.ts +6 -6
- package/src/funcs/subscriptions-list-all-subscription-schedules.ts +1 -1
- package/src/funcs/subscriptions-list-subscription-schedules.ts +6 -8
- package/src/funcs/tasks-create-task.ts +172 -0
- package/src/funcs/usage-records-post-usage-records-search.ts +172 -0
- package/src/funcs/users-remove-user.ts +181 -0
- package/src/funcs/webhook-events-post-webhook-events-invoice-communication-triggered.ts +1 -1
- package/src/funcs/webhook-events-post-webhook-events-invoice-create-drafted.ts +1 -1
- package/src/funcs/webhook-events-post-webhook-events-invoice-payment-overdue.ts +1 -1
- package/src/funcs/webhook-events-post-webhook-events-invoice-update-finalized.ts +1 -1
- package/src/funcs/webhook-events-post-webhook-events-invoice-update-payment.ts +1 -1
- package/src/funcs/webhook-events-post-webhook-events-invoice-update-voided.ts +1 -1
- package/src/funcs/webhook-events-post-webhook-events-invoice-update.ts +1 -1
- package/src/funcs/webhook-events-post-webhook-events-refund-created.ts +144 -0
- package/src/funcs/webhook-events-post-webhook-events-refund-failed.ts +144 -0
- package/src/funcs/webhook-events-post-webhook-events-refund-succeeded.ts +144 -0
- package/src/lib/config.ts +3 -3
- package/src/lib/encodings.ts +58 -23
- package/src/sdk/credit-notes.ts +2 -0
- package/src/sdk/invoices.ts +20 -0
- package/src/sdk/models/add-addon-params.ts +0 -29
- package/src/sdk/models/add-addon-ref.ts +1 -38
- package/src/sdk/models/add-line-item-request.ts +57 -0
- package/src/sdk/models/addon-cadence.ts +4 -8
- package/src/sdk/models/alert-settings.ts +11 -0
- package/src/sdk/models/alert-threshold-type.ts +24 -0
- package/src/sdk/models/billing-period-behaviour.ts +25 -0
- package/src/sdk/models/billing-period-config.ts +57 -0
- package/src/sdk/models/changed-invoice-status.ts +0 -6
- package/src/sdk/models/changed-invoice.ts +0 -3
- package/src/sdk/models/checkout-payment-block.ts +39 -0
- package/src/sdk/models/checkout-payment-provider-config.ts +11 -0
- package/src/sdk/models/checkout-payment-provider.ts +12 -10
- package/src/sdk/models/checkout-session-response.ts +28 -71
- package/src/sdk/models/collection-method.ts +5 -12
- package/src/sdk/models/create-credit-note-request.ts +5 -0
- package/src/sdk/models/create-customer-request.ts +5 -0
- package/src/sdk/models/create-invoice-request.ts +0 -12
- package/src/sdk/models/create-price-request.ts +5 -0
- package/src/sdk/models/create-subscription-params.ts +0 -40
- package/src/sdk/models/create-subscription-request.ts +17 -0
- package/src/sdk/models/create-task-request.ts +64 -0
- package/src/sdk/models/create-tax-association-request.ts +5 -0
- package/src/sdk/models/create-tax-rate-request.ts +1 -8
- package/src/sdk/models/credit-grant-application-response.ts +2 -2
- package/src/sdk/models/custom-currency-line-item.ts +47 -0
- package/src/sdk/models/custom-currency.ts +59 -0
- package/src/sdk/models/customer-response.ts +4 -0
- package/src/sdk/models/customer.ts +4 -0
- package/src/sdk/models/entitlement-response.ts +2 -2
- package/src/sdk/models/entity-change-behaviour.ts +1 -0
- package/src/sdk/models/entity-change-policy.ts +3 -0
- package/src/sdk/models/entity-change-result.ts +5 -5
- package/src/sdk/models/entity-type.ts +3 -0
- package/src/sdk/models/execute-invoice-modify-op.ts +46 -0
- package/src/sdk/models/execute-invoice-modify-request.ts +52 -0
- package/src/sdk/models/file-type.ts +3 -0
- package/src/sdk/models/finalize-credit-note-request.ts +39 -0
- package/src/sdk/models/get-refund-op.ts +33 -0
- package/src/sdk/models/get-subscription-schedule-op.ts +13 -5
- package/src/sdk/models/global-custom-field.ts +33 -0
- package/src/sdk/models/index.ts +56 -6
- package/src/sdk/models/invoice-line-item-response.ts +7 -0
- package/src/sdk/models/invoice-modify-line-item-action.ts +20 -0
- package/src/sdk/models/invoice-modify-line-item-params.ts +76 -0
- package/src/sdk/models/invoice-modify-response.ts +35 -0
- package/src/sdk/models/invoice-modify-type.ts +16 -0
- package/src/sdk/models/invoice-response.ts +20 -0
- package/src/sdk/models/invoice-sync-settings.ts +54 -0
- package/src/sdk/models/list-addon-associations-response.ts +41 -0
- package/src/sdk/models/list-refunds-op.ts +94 -0
- package/src/sdk/models/list-refunds-response.ts +41 -0
- package/src/sdk/models/list-subscription-schedules-op.ts +5 -13
- package/src/sdk/models/list-usage-records-response.ts +41 -0
- package/src/sdk/models/metadata-custom-field-source.ts +21 -0
- package/src/sdk/models/metadata-custom-field.ts +47 -0
- package/src/sdk/models/meter-aggregation.ts +2 -1
- package/src/sdk/models/modify-subscription-line-item.ts +0 -30
- package/src/sdk/models/modify-subscription-params.ts +0 -32
- package/src/sdk/models/on-pending-schedule-policy.ts +19 -0
- package/src/sdk/models/override-line-item-request.ts +5 -0
- package/src/sdk/models/payment-gateway-type.ts +1 -0
- package/src/sdk/models/plan-price-sync-status-response.ts +44 -0
- package/src/sdk/models/plan-response.ts +9 -0
- package/src/sdk/models/price-feature-response.ts +43 -0
- package/src/sdk/models/price-price.ts +4 -0
- package/src/sdk/models/price-response.ts +10 -0
- package/src/sdk/models/process-credit-note-op.ts +11 -0
- package/src/sdk/models/refund-destination.ts +20 -0
- package/src/sdk/models/refund-reason.ts +21 -0
- package/src/sdk/models/refund-response.ts +130 -0
- package/src/sdk/models/refund-status.ts +20 -0
- package/src/sdk/models/refund-target.ts +16 -0
- package/src/sdk/models/remove-user-op.ts +33 -0
- package/src/sdk/models/retry-refund-op.ts +33 -0
- package/src/sdk/models/s3-job-config.ts +9 -0
- package/src/sdk/models/secret-provider.ts +1 -0
- package/src/sdk/models/{s3-export-config.ts → storage-export-config.ts} +11 -11
- package/src/sdk/models/subscription-change-billing-period-result.ts +52 -0
- package/src/sdk/models/subscription-change-conflict-policies.ts +44 -0
- package/src/sdk/models/subscription-change-entity-type.ts +24 -0
- package/src/sdk/models/subscription-change-v2-request.ts +30 -0
- package/src/sdk/models/subscription-change-v2-response.ts +18 -0
- package/src/sdk/models/subscription-price-create-request.ts +5 -0
- package/src/sdk/models/sync-config.ts +6 -6
- package/src/sdk/models/task-type.ts +3 -0
- package/src/sdk/models/tax-applied-response.ts +4 -0
- package/src/sdk/models/tax-association-response.ts +4 -0
- package/src/sdk/models/tax-association-update-request.ts +5 -0
- package/src/sdk/models/tax-behavior.ts +20 -0
- package/src/sdk/models/tax-exemption-reason-code.ts +19 -0
- package/src/sdk/models/tax-exemption-summary.ts +45 -0
- package/src/sdk/models/tax-rate-override.ts +5 -0
- package/src/sdk/models/tax-rate-response.ts +3 -84
- package/src/sdk/models/tax-rate-type.ts +6 -8
- package/src/sdk/models/tax-summary.ts +49 -0
- package/src/sdk/models/tax-treatment.ts +20 -0
- package/src/sdk/models/update-customer-request.ts +5 -0
- package/src/sdk/models/update-line-item-request.ts +57 -0
- package/src/sdk/models/update-payment-request.ts +10 -0
- package/src/sdk/models/update-price-request.ts +5 -0
- package/src/sdk/models/update-subscription-line-item-request.ts +5 -0
- package/src/sdk/models/usage-record-filter.ts +130 -0
- package/src/sdk/models/usage-record-response.ts +93 -0
- package/src/sdk/models/usage-record-sync-entry.ts +70 -0
- package/src/sdk/models/wallet-topup-params.ts +0 -29
- package/src/sdk/models/webhook-dto-coupon-application.ts +76 -0
- package/src/sdk/models/webhook-dto-coupon-association.ts +55 -0
- package/src/sdk/models/webhook-dto-invoice-line-item.ts +47 -0
- package/src/sdk/models/webhook-dto-invoice-webhook-payload.ts +6 -6
- package/src/sdk/models/webhook-dto-invoice.ts +45 -0
- package/src/sdk/models/webhook-dto-meter.ts +53 -0
- package/src/sdk/models/webhook-dto-plan.ts +53 -0
- package/src/sdk/models/webhook-dto-price.ts +123 -0
- package/src/sdk/models/webhook-dto-refund-webhook-payload.ts +49 -0
- package/src/sdk/models/webhook-dto-refund.ts +91 -0
- package/src/sdk/models/webhook-dto-subscription-line-item.ts +108 -0
- package/src/sdk/models/webhook-dto-subscription-webhook-payload.ts +6 -0
- package/src/sdk/models/webhook-dto-subscription.ts +27 -0
- package/src/sdk/models/webhook-dto-tax-applied.ts +65 -0
- package/src/sdk/models/webhook-dto-tax-rate.ts +51 -0
- package/src/sdk/models/webhook-dto-wallet-webhook-payload.ts +6 -0
- package/src/sdk/models/webhook-event-name.ts +3 -0
- package/src/sdk/refunds.ts +63 -0
- package/src/sdk/sdk.ts +12 -0
- package/src/sdk/subscriptions.ts +75 -73
- package/src/sdk/tasks.ts +18 -0
- package/src/sdk/usage-records.ts +27 -0
- package/src/sdk/users.ts +18 -0
- package/src/sdk/webhook-events.ts +55 -7
- package/docs/sdk/models/checkout-jsonb-checkout-configuration.md +0 -18
- package/docs/sdk/models/checkout-jsonb-checkout-payment-provider-config.md +0 -17
- package/docs/sdk/models/checkout-jsonb-checkout-result.md +0 -15
- package/docs/sdk/models/create-subscription-result.md +0 -17
- package/docs/sdk/models/s3-export-config.md +0 -20
- package/esm/sdk/models/checkout-jsonb-checkout-configuration.d.ts +0 -17
- package/esm/sdk/models/checkout-jsonb-checkout-configuration.d.ts.map +0 -1
- package/esm/sdk/models/checkout-jsonb-checkout-configuration.js +0 -29
- package/esm/sdk/models/checkout-jsonb-checkout-configuration.js.map +0 -1
- package/esm/sdk/models/checkout-jsonb-checkout-payment-provider-config.d.ts +0 -14
- package/esm/sdk/models/checkout-jsonb-checkout-payment-provider-config.d.ts.map +0 -1
- package/esm/sdk/models/checkout-jsonb-checkout-payment-provider-config.js +0 -25
- package/esm/sdk/models/checkout-jsonb-checkout-payment-provider-config.js.map +0 -1
- package/esm/sdk/models/checkout-jsonb-checkout-provider-result.d.ts +0 -41
- package/esm/sdk/models/checkout-jsonb-checkout-provider-result.d.ts.map +0 -1
- package/esm/sdk/models/checkout-jsonb-checkout-provider-result.js +0 -28
- package/esm/sdk/models/checkout-jsonb-checkout-provider-result.js.map +0 -1
- package/esm/sdk/models/checkout-jsonb-checkout-result.d.ts +0 -11
- package/esm/sdk/models/checkout-jsonb-checkout-result.d.ts.map +0 -1
- package/esm/sdk/models/checkout-jsonb-checkout-result.js +0 -20
- package/esm/sdk/models/checkout-jsonb-checkout-result.js.map +0 -1
- package/esm/sdk/models/create-subscription-result.d.ts +0 -12
- package/esm/sdk/models/create-subscription-result.d.ts.map +0 -1
- package/esm/sdk/models/create-subscription-result.js +0 -23
- package/esm/sdk/models/create-subscription-result.js.map +0 -1
- package/esm/sdk/models/s3-export-config.d.ts.map +0 -1
- package/esm/sdk/models/s3-export-config.js.map +0 -1
- package/src/sdk/models/checkout-jsonb-checkout-configuration.ts +0 -69
- package/src/sdk/models/checkout-jsonb-checkout-payment-provider-config.ts +0 -57
- package/src/sdk/models/checkout-jsonb-checkout-provider-result.ts +0 -80
- package/src/sdk/models/checkout-jsonb-checkout-result.ts +0 -45
- package/src/sdk/models/create-subscription-result.ts +0 -45
|
@@ -10,6 +10,9 @@
|
|
|
10
10
|
* [querySubscriptionLineItems](#querysubscriptionlineitems) - Search subscription line items
|
|
11
11
|
* [updateSubscriptionLineItem](#updatesubscriptionlineitem) - Update subscription line item
|
|
12
12
|
* [deleteSubscriptionLineItem](#deletesubscriptionlineitem) - Delete subscription line item
|
|
13
|
+
* [listAllSubscriptionSchedules](#listallsubscriptionschedules) - List all subscription schedules
|
|
14
|
+
* [getSubscriptionSchedule](#getsubscriptionschedule) - Get subscription schedule
|
|
15
|
+
* [cancelSubscriptionSchedule](#cancelsubscriptionschedule) - Cancel subscription schedule
|
|
13
16
|
* [querySubscription](#querysubscription) - Query subscriptions
|
|
14
17
|
* [getSubscriptionUsage](#getsubscriptionusage) - Get usage by subscription
|
|
15
18
|
* [getSubscription](#getsubscription) - Get subscription
|
|
@@ -26,11 +29,8 @@
|
|
|
26
29
|
* [createSubscriptionLineItem](#createsubscriptionlineitem) - Create subscription line item
|
|
27
30
|
* [executeSubscriptionModify](#executesubscriptionmodify) - Execute subscription modification
|
|
28
31
|
* [previewSubscriptionModify](#previewsubscriptionmodify) - Preview subscription modification
|
|
29
|
-
* [getSubscriptionV2](#getsubscriptionv2) - Get subscription (V2)
|
|
30
|
-
* [listAllSubscriptionSchedules](#listallsubscriptionschedules) - List all subscription schedules
|
|
31
|
-
* [getSubscriptionSchedule](#getsubscriptionschedule) - Get subscription schedule
|
|
32
|
-
* [cancelSubscriptionSchedule](#cancelsubscriptionschedule) - Cancel subscription schedule
|
|
33
32
|
* [listSubscriptionSchedules](#listsubscriptionschedules) - List subscription schedules
|
|
33
|
+
* [getSubscriptionV2](#getsubscriptionv2) - Get subscription (V2)
|
|
34
34
|
|
|
35
35
|
## createSubscription
|
|
36
36
|
|
|
@@ -484,6 +484,217 @@ run();
|
|
|
484
484
|
| models.ErrorsErrorResponse | 500 | application/json |
|
|
485
485
|
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
486
486
|
|
|
487
|
+
## listAllSubscriptionSchedules
|
|
488
|
+
|
|
489
|
+
Use when listing or searching scheduled changes across subscriptions (e.g. admin view). Returns schedules with optional filtering.
|
|
490
|
+
|
|
491
|
+
### Example Usage
|
|
492
|
+
|
|
493
|
+
<!-- UsageSnippet language="typescript" operationID="listAllSubscriptionSchedules" method="get" path="/subscriptions/schedules" -->
|
|
494
|
+
```typescript
|
|
495
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
496
|
+
|
|
497
|
+
const flexprice = new Flexprice({
|
|
498
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
499
|
+
});
|
|
500
|
+
|
|
501
|
+
async function run() {
|
|
502
|
+
const result = await flexprice.subscriptions.listAllSubscriptionSchedules();
|
|
503
|
+
|
|
504
|
+
console.log(result);
|
|
505
|
+
}
|
|
506
|
+
|
|
507
|
+
run();
|
|
508
|
+
```
|
|
509
|
+
|
|
510
|
+
### Standalone function
|
|
511
|
+
|
|
512
|
+
The standalone function version of this method:
|
|
513
|
+
|
|
514
|
+
```typescript
|
|
515
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
516
|
+
import { subscriptionsListAllSubscriptionSchedules } from "@flexprice/sdk/funcs/subscriptions-list-all-subscription-schedules.js";
|
|
517
|
+
|
|
518
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
519
|
+
// You can create one instance of it to use across an application.
|
|
520
|
+
const flexprice = new FlexpriceCore({
|
|
521
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
522
|
+
});
|
|
523
|
+
|
|
524
|
+
async function run() {
|
|
525
|
+
const res = await subscriptionsListAllSubscriptionSchedules(flexprice);
|
|
526
|
+
if (res.ok) {
|
|
527
|
+
const { value: result } = res;
|
|
528
|
+
console.log(result);
|
|
529
|
+
} else {
|
|
530
|
+
console.log("subscriptionsListAllSubscriptionSchedules failed:", res.error);
|
|
531
|
+
}
|
|
532
|
+
}
|
|
533
|
+
|
|
534
|
+
run();
|
|
535
|
+
```
|
|
536
|
+
|
|
537
|
+
### Parameters
|
|
538
|
+
|
|
539
|
+
| Parameter | Type | Required | Description |
|
|
540
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
541
|
+
| `pendingOnly` | *boolean* | :heavy_minus_sign: | Filter to pending schedules only |
|
|
542
|
+
| `subscriptionId` | *string* | :heavy_minus_sign: | Filter by subscription ID |
|
|
543
|
+
| `limit` | *number* | :heavy_minus_sign: | Limit results |
|
|
544
|
+
| `offset` | *number* | :heavy_minus_sign: | Offset for pagination |
|
|
545
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
546
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
547
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
548
|
+
|
|
549
|
+
### Response
|
|
550
|
+
|
|
551
|
+
**Promise\<[models.GetPendingSchedulesResponse](../../sdk/models/get-pending-schedules-response.md)\>**
|
|
552
|
+
|
|
553
|
+
### Errors
|
|
554
|
+
|
|
555
|
+
| Error Type | Status Code | Content Type |
|
|
556
|
+
| --------------- | --------------- | --------------- |
|
|
557
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
558
|
+
|
|
559
|
+
## getSubscriptionSchedule
|
|
560
|
+
|
|
561
|
+
Use when you need to load a single scheduled change (e.g. to show when a plan change or renewal takes effect).
|
|
562
|
+
|
|
563
|
+
### Example Usage
|
|
564
|
+
|
|
565
|
+
<!-- UsageSnippet language="typescript" operationID="getSubscriptionSchedule" method="get" path="/subscriptions/schedules/{schedule_id}" -->
|
|
566
|
+
```typescript
|
|
567
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
568
|
+
|
|
569
|
+
const flexprice = new Flexprice({
|
|
570
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
571
|
+
});
|
|
572
|
+
|
|
573
|
+
async function run() {
|
|
574
|
+
const result = await flexprice.subscriptions.getSubscriptionSchedule("<id>");
|
|
575
|
+
|
|
576
|
+
console.log(result);
|
|
577
|
+
}
|
|
578
|
+
|
|
579
|
+
run();
|
|
580
|
+
```
|
|
581
|
+
|
|
582
|
+
### Standalone function
|
|
583
|
+
|
|
584
|
+
The standalone function version of this method:
|
|
585
|
+
|
|
586
|
+
```typescript
|
|
587
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
588
|
+
import { subscriptionsGetSubscriptionSchedule } from "@flexprice/sdk/funcs/subscriptions-get-subscription-schedule.js";
|
|
589
|
+
|
|
590
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
591
|
+
// You can create one instance of it to use across an application.
|
|
592
|
+
const flexprice = new FlexpriceCore({
|
|
593
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
594
|
+
});
|
|
595
|
+
|
|
596
|
+
async function run() {
|
|
597
|
+
const res = await subscriptionsGetSubscriptionSchedule(flexprice, "<id>");
|
|
598
|
+
if (res.ok) {
|
|
599
|
+
const { value: result } = res;
|
|
600
|
+
console.log(result);
|
|
601
|
+
} else {
|
|
602
|
+
console.log("subscriptionsGetSubscriptionSchedule failed:", res.error);
|
|
603
|
+
}
|
|
604
|
+
}
|
|
605
|
+
|
|
606
|
+
run();
|
|
607
|
+
```
|
|
608
|
+
|
|
609
|
+
### Parameters
|
|
610
|
+
|
|
611
|
+
| Parameter | Type | Required | Description |
|
|
612
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
613
|
+
| `scheduleId` | *string* | :heavy_check_mark: | Schedule ID |
|
|
614
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
615
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
616
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
617
|
+
|
|
618
|
+
### Response
|
|
619
|
+
|
|
620
|
+
**Promise\<[models.SubscriptionScheduleResponse](../../sdk/models/subscription-schedule-response.md)\>**
|
|
621
|
+
|
|
622
|
+
### Errors
|
|
623
|
+
|
|
624
|
+
| Error Type | Status Code | Content Type |
|
|
625
|
+
| --------------- | --------------- | --------------- |
|
|
626
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
627
|
+
|
|
628
|
+
## cancelSubscriptionSchedule
|
|
629
|
+
|
|
630
|
+
Use when cancelling a scheduled change (e.g. customer changed mind). Identify by schedule ID in path or by subscription ID + schedule type in body.
|
|
631
|
+
|
|
632
|
+
### Example Usage
|
|
633
|
+
|
|
634
|
+
<!-- UsageSnippet language="typescript" operationID="cancelSubscriptionSchedule" method="post" path="/subscriptions/schedules/{schedule_id}/cancel" -->
|
|
635
|
+
```typescript
|
|
636
|
+
import { Flexprice } from "@flexprice/sdk";
|
|
637
|
+
|
|
638
|
+
const flexprice = new Flexprice({
|
|
639
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
640
|
+
});
|
|
641
|
+
|
|
642
|
+
async function run() {
|
|
643
|
+
const result = await flexprice.subscriptions.cancelSubscriptionSchedule("<id>");
|
|
644
|
+
|
|
645
|
+
console.log(result);
|
|
646
|
+
}
|
|
647
|
+
|
|
648
|
+
run();
|
|
649
|
+
```
|
|
650
|
+
|
|
651
|
+
### Standalone function
|
|
652
|
+
|
|
653
|
+
The standalone function version of this method:
|
|
654
|
+
|
|
655
|
+
```typescript
|
|
656
|
+
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
657
|
+
import { subscriptionsCancelSubscriptionSchedule } from "@flexprice/sdk/funcs/subscriptions-cancel-subscription-schedule.js";
|
|
658
|
+
|
|
659
|
+
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
660
|
+
// You can create one instance of it to use across an application.
|
|
661
|
+
const flexprice = new FlexpriceCore({
|
|
662
|
+
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
663
|
+
});
|
|
664
|
+
|
|
665
|
+
async function run() {
|
|
666
|
+
const res = await subscriptionsCancelSubscriptionSchedule(flexprice, "<id>");
|
|
667
|
+
if (res.ok) {
|
|
668
|
+
const { value: result } = res;
|
|
669
|
+
console.log(result);
|
|
670
|
+
} else {
|
|
671
|
+
console.log("subscriptionsCancelSubscriptionSchedule failed:", res.error);
|
|
672
|
+
}
|
|
673
|
+
}
|
|
674
|
+
|
|
675
|
+
run();
|
|
676
|
+
```
|
|
677
|
+
|
|
678
|
+
### Parameters
|
|
679
|
+
|
|
680
|
+
| Parameter | Type | Required | Description |
|
|
681
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
682
|
+
| `scheduleId` | *string* | :heavy_check_mark: | Schedule ID (optional if using request body) |
|
|
683
|
+
| `body` | [models.CancelScheduleRequest](../../sdk/models/cancel-schedule-request.md) | :heavy_minus_sign: | Cancel request (optional if using path parameter) |
|
|
684
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
685
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
686
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
687
|
+
|
|
688
|
+
### Response
|
|
689
|
+
|
|
690
|
+
**Promise\<[models.CancelScheduleResponse](../../sdk/models/cancel-schedule-response.md)\>**
|
|
691
|
+
|
|
692
|
+
### Errors
|
|
693
|
+
|
|
694
|
+
| Error Type | Status Code | Content Type |
|
|
695
|
+
| --------------- | --------------- | --------------- |
|
|
696
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
697
|
+
|
|
487
698
|
## querySubscription
|
|
488
699
|
|
|
489
700
|
Use when listing or searching subscriptions (e.g. admin view or customer subscription list). Returns a paginated list; supports filtering by customer, plan, status.
|
|
@@ -916,7 +1127,7 @@ run();
|
|
|
916
1127
|
|
|
917
1128
|
### Response
|
|
918
1129
|
|
|
919
|
-
**Promise\<[models.
|
|
1130
|
+
**Promise\<[models.ListAddonAssociationsResponse](../../sdk/models/list-addon-associations-response.md)\>**
|
|
920
1131
|
|
|
921
1132
|
### Errors
|
|
922
1133
|
|
|
@@ -1178,7 +1389,9 @@ change_at controls timing. Omitted or 'immediate' applies the change now. 'end_o
|
|
|
1178
1389
|
|
|
1179
1390
|
scheduled_at is resolved from the subscription's current period end at request time. If that period end is already in the past (a backdated start date, a resumed pause, or worker downtime can all leave a subscription behind), the change is due immediately and fires on the next billing scan rather than a period away — inspect scheduled_at to see this.
|
|
1180
1391
|
|
|
1181
|
-
Only one plan change may be pending per subscription
|
|
1392
|
+
Only one plan change may be pending per subscription. By default (on_conflict_policies.on_pending_schedule = 'reject') a second request returns 400; cancel the existing schedule via POST /subscriptions/schedules/{schedule_id}/cancel first. Pending schedules are listable via GET /subscriptions/{id}/schedules.
|
|
1393
|
+
|
|
1394
|
+
Set on_conflict_policies.on_pending_schedule to 'supersede' to replace the queued change instead: the pending schedule is cancelled and this request applied in the same transaction, so both land or neither does. The cancelled schedule ids are returned in superseded_schedules, and preview reports the same list without writing.
|
|
1182
1395
|
|
|
1183
1396
|
### Example Usage
|
|
1184
1397
|
|
|
@@ -1699,13 +1912,13 @@ run();
|
|
|
1699
1912
|
| models.ErrorsErrorResponse | 500 | application/json |
|
|
1700
1913
|
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1701
1914
|
|
|
1702
|
-
##
|
|
1915
|
+
## listSubscriptionSchedules
|
|
1703
1916
|
|
|
1704
|
-
Use when
|
|
1917
|
+
Use when listing scheduled changes for a subscription (e.g. upcoming plan change or renewal). Returns all schedules for that subscription.
|
|
1705
1918
|
|
|
1706
1919
|
### Example Usage
|
|
1707
1920
|
|
|
1708
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
1921
|
+
<!-- UsageSnippet language="typescript" operationID="listSubscriptionSchedules" method="get" path="/subscriptions/{id}/schedules" -->
|
|
1709
1922
|
```typescript
|
|
1710
1923
|
import { Flexprice } from "@flexprice/sdk";
|
|
1711
1924
|
|
|
@@ -1714,7 +1927,7 @@ const flexprice = new Flexprice({
|
|
|
1714
1927
|
});
|
|
1715
1928
|
|
|
1716
1929
|
async function run() {
|
|
1717
|
-
const result = await flexprice.subscriptions.
|
|
1930
|
+
const result = await flexprice.subscriptions.listSubscriptionSchedules("<id>");
|
|
1718
1931
|
|
|
1719
1932
|
console.log(result);
|
|
1720
1933
|
}
|
|
@@ -1728,7 +1941,7 @@ The standalone function version of this method:
|
|
|
1728
1941
|
|
|
1729
1942
|
```typescript
|
|
1730
1943
|
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1731
|
-
import {
|
|
1944
|
+
import { subscriptionsListSubscriptionSchedules } from "@flexprice/sdk/funcs/subscriptions-list-subscription-schedules.js";
|
|
1732
1945
|
|
|
1733
1946
|
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1734
1947
|
// You can create one instance of it to use across an application.
|
|
@@ -1737,12 +1950,12 @@ const flexprice = new FlexpriceCore({
|
|
|
1737
1950
|
});
|
|
1738
1951
|
|
|
1739
1952
|
async function run() {
|
|
1740
|
-
const res = await
|
|
1953
|
+
const res = await subscriptionsListSubscriptionSchedules(flexprice, "<id>");
|
|
1741
1954
|
if (res.ok) {
|
|
1742
1955
|
const { value: result } = res;
|
|
1743
1956
|
console.log(result);
|
|
1744
1957
|
} else {
|
|
1745
|
-
console.log("
|
|
1958
|
+
console.log("subscriptionsListSubscriptionSchedules failed:", res.error);
|
|
1746
1959
|
}
|
|
1747
1960
|
}
|
|
1748
1961
|
|
|
@@ -1754,81 +1967,6 @@ run();
|
|
|
1754
1967
|
| Parameter | Type | Required | Description |
|
|
1755
1968
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1756
1969
|
| `id` | *string* | :heavy_check_mark: | Subscription ID |
|
|
1757
|
-
| `expand` | *string* | :heavy_minus_sign: | Comma-separated list of fields to expand (e.g., 'subscription_line_items,prices,plan') |
|
|
1758
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1759
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1760
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1761
|
-
|
|
1762
|
-
### Response
|
|
1763
|
-
|
|
1764
|
-
**Promise\<[models.SubscriptionResponseV2](../../sdk/models/subscription-response-v2.md)\>**
|
|
1765
|
-
|
|
1766
|
-
### Errors
|
|
1767
|
-
|
|
1768
|
-
| Error Type | Status Code | Content Type |
|
|
1769
|
-
| -------------------------- | -------------------------- | -------------------------- |
|
|
1770
|
-
| models.ErrorsErrorResponse | 400 | application/json |
|
|
1771
|
-
| models.ErrorsErrorResponse | 500 | application/json |
|
|
1772
|
-
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1773
|
-
|
|
1774
|
-
## listAllSubscriptionSchedules
|
|
1775
|
-
|
|
1776
|
-
Use when listing or searching scheduled changes across subscriptions (e.g. admin view). Returns schedules with optional filtering.
|
|
1777
|
-
|
|
1778
|
-
### Example Usage
|
|
1779
|
-
|
|
1780
|
-
<!-- UsageSnippet language="typescript" operationID="listAllSubscriptionSchedules" method="get" path="/v1/subscription-schedules" -->
|
|
1781
|
-
```typescript
|
|
1782
|
-
import { Flexprice } from "@flexprice/sdk";
|
|
1783
|
-
|
|
1784
|
-
const flexprice = new Flexprice({
|
|
1785
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1786
|
-
});
|
|
1787
|
-
|
|
1788
|
-
async function run() {
|
|
1789
|
-
const result = await flexprice.subscriptions.listAllSubscriptionSchedules();
|
|
1790
|
-
|
|
1791
|
-
console.log(result);
|
|
1792
|
-
}
|
|
1793
|
-
|
|
1794
|
-
run();
|
|
1795
|
-
```
|
|
1796
|
-
|
|
1797
|
-
### Standalone function
|
|
1798
|
-
|
|
1799
|
-
The standalone function version of this method:
|
|
1800
|
-
|
|
1801
|
-
```typescript
|
|
1802
|
-
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1803
|
-
import { subscriptionsListAllSubscriptionSchedules } from "@flexprice/sdk/funcs/subscriptions-list-all-subscription-schedules.js";
|
|
1804
|
-
|
|
1805
|
-
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1806
|
-
// You can create one instance of it to use across an application.
|
|
1807
|
-
const flexprice = new FlexpriceCore({
|
|
1808
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1809
|
-
});
|
|
1810
|
-
|
|
1811
|
-
async function run() {
|
|
1812
|
-
const res = await subscriptionsListAllSubscriptionSchedules(flexprice);
|
|
1813
|
-
if (res.ok) {
|
|
1814
|
-
const { value: result } = res;
|
|
1815
|
-
console.log(result);
|
|
1816
|
-
} else {
|
|
1817
|
-
console.log("subscriptionsListAllSubscriptionSchedules failed:", res.error);
|
|
1818
|
-
}
|
|
1819
|
-
}
|
|
1820
|
-
|
|
1821
|
-
run();
|
|
1822
|
-
```
|
|
1823
|
-
|
|
1824
|
-
### Parameters
|
|
1825
|
-
|
|
1826
|
-
| Parameter | Type | Required | Description |
|
|
1827
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1828
|
-
| `pendingOnly` | *boolean* | :heavy_minus_sign: | Filter to pending schedules only |
|
|
1829
|
-
| `subscriptionId` | *string* | :heavy_minus_sign: | Filter by subscription ID |
|
|
1830
|
-
| `limit` | *number* | :heavy_minus_sign: | Limit results |
|
|
1831
|
-
| `offset` | *number* | :heavy_minus_sign: | Offset for pagination |
|
|
1832
1970
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1833
1971
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1834
1972
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -1843,152 +1981,13 @@ run();
|
|
|
1843
1981
|
| --------------- | --------------- | --------------- |
|
|
1844
1982
|
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1845
1983
|
|
|
1846
|
-
##
|
|
1847
|
-
|
|
1848
|
-
Use when you need to load a single scheduled change (e.g. to show when a plan change or renewal takes effect).
|
|
1849
|
-
|
|
1850
|
-
### Example Usage
|
|
1851
|
-
|
|
1852
|
-
<!-- UsageSnippet language="typescript" operationID="getSubscriptionSchedule" method="get" path="/v1/subscription-schedules/{id}" -->
|
|
1853
|
-
```typescript
|
|
1854
|
-
import { Flexprice } from "@flexprice/sdk";
|
|
1855
|
-
|
|
1856
|
-
const flexprice = new Flexprice({
|
|
1857
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1858
|
-
});
|
|
1859
|
-
|
|
1860
|
-
async function run() {
|
|
1861
|
-
const result = await flexprice.subscriptions.getSubscriptionSchedule("<id>");
|
|
1862
|
-
|
|
1863
|
-
console.log(result);
|
|
1864
|
-
}
|
|
1865
|
-
|
|
1866
|
-
run();
|
|
1867
|
-
```
|
|
1868
|
-
|
|
1869
|
-
### Standalone function
|
|
1870
|
-
|
|
1871
|
-
The standalone function version of this method:
|
|
1872
|
-
|
|
1873
|
-
```typescript
|
|
1874
|
-
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1875
|
-
import { subscriptionsGetSubscriptionSchedule } from "@flexprice/sdk/funcs/subscriptions-get-subscription-schedule.js";
|
|
1876
|
-
|
|
1877
|
-
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1878
|
-
// You can create one instance of it to use across an application.
|
|
1879
|
-
const flexprice = new FlexpriceCore({
|
|
1880
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1881
|
-
});
|
|
1882
|
-
|
|
1883
|
-
async function run() {
|
|
1884
|
-
const res = await subscriptionsGetSubscriptionSchedule(flexprice, "<id>");
|
|
1885
|
-
if (res.ok) {
|
|
1886
|
-
const { value: result } = res;
|
|
1887
|
-
console.log(result);
|
|
1888
|
-
} else {
|
|
1889
|
-
console.log("subscriptionsGetSubscriptionSchedule failed:", res.error);
|
|
1890
|
-
}
|
|
1891
|
-
}
|
|
1892
|
-
|
|
1893
|
-
run();
|
|
1894
|
-
```
|
|
1895
|
-
|
|
1896
|
-
### Parameters
|
|
1897
|
-
|
|
1898
|
-
| Parameter | Type | Required | Description |
|
|
1899
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1900
|
-
| `id` | *string* | :heavy_check_mark: | Schedule ID |
|
|
1901
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1902
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1903
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1904
|
-
|
|
1905
|
-
### Response
|
|
1906
|
-
|
|
1907
|
-
**Promise\<[models.SubscriptionScheduleResponse](../../sdk/models/subscription-schedule-response.md)\>**
|
|
1908
|
-
|
|
1909
|
-
### Errors
|
|
1910
|
-
|
|
1911
|
-
| Error Type | Status Code | Content Type |
|
|
1912
|
-
| --------------- | --------------- | --------------- |
|
|
1913
|
-
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1914
|
-
|
|
1915
|
-
## cancelSubscriptionSchedule
|
|
1916
|
-
|
|
1917
|
-
Use when cancelling a scheduled change (e.g. customer changed mind). Identify by schedule ID in path or by subscription ID + schedule type in body.
|
|
1918
|
-
|
|
1919
|
-
### Example Usage
|
|
1920
|
-
|
|
1921
|
-
<!-- UsageSnippet language="typescript" operationID="cancelSubscriptionSchedule" method="post" path="/v1/subscriptions/schedules/{schedule_id}/cancel" -->
|
|
1922
|
-
```typescript
|
|
1923
|
-
import { Flexprice } from "@flexprice/sdk";
|
|
1924
|
-
|
|
1925
|
-
const flexprice = new Flexprice({
|
|
1926
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1927
|
-
});
|
|
1928
|
-
|
|
1929
|
-
async function run() {
|
|
1930
|
-
const result = await flexprice.subscriptions.cancelSubscriptionSchedule("<id>");
|
|
1931
|
-
|
|
1932
|
-
console.log(result);
|
|
1933
|
-
}
|
|
1934
|
-
|
|
1935
|
-
run();
|
|
1936
|
-
```
|
|
1937
|
-
|
|
1938
|
-
### Standalone function
|
|
1939
|
-
|
|
1940
|
-
The standalone function version of this method:
|
|
1941
|
-
|
|
1942
|
-
```typescript
|
|
1943
|
-
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
1944
|
-
import { subscriptionsCancelSubscriptionSchedule } from "@flexprice/sdk/funcs/subscriptions-cancel-subscription-schedule.js";
|
|
1945
|
-
|
|
1946
|
-
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
1947
|
-
// You can create one instance of it to use across an application.
|
|
1948
|
-
const flexprice = new FlexpriceCore({
|
|
1949
|
-
apiKeyAuth: "<YOUR_API_KEY_HERE>",
|
|
1950
|
-
});
|
|
1951
|
-
|
|
1952
|
-
async function run() {
|
|
1953
|
-
const res = await subscriptionsCancelSubscriptionSchedule(flexprice, "<id>");
|
|
1954
|
-
if (res.ok) {
|
|
1955
|
-
const { value: result } = res;
|
|
1956
|
-
console.log(result);
|
|
1957
|
-
} else {
|
|
1958
|
-
console.log("subscriptionsCancelSubscriptionSchedule failed:", res.error);
|
|
1959
|
-
}
|
|
1960
|
-
}
|
|
1961
|
-
|
|
1962
|
-
run();
|
|
1963
|
-
```
|
|
1964
|
-
|
|
1965
|
-
### Parameters
|
|
1966
|
-
|
|
1967
|
-
| Parameter | Type | Required | Description |
|
|
1968
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1969
|
-
| `scheduleId` | *string* | :heavy_check_mark: | Schedule ID (optional if using request body) |
|
|
1970
|
-
| `body` | [models.CancelScheduleRequest](../../sdk/models/cancel-schedule-request.md) | :heavy_minus_sign: | Cancel request (optional if using path parameter) |
|
|
1971
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1972
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1973
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1974
|
-
|
|
1975
|
-
### Response
|
|
1976
|
-
|
|
1977
|
-
**Promise\<[models.CancelScheduleResponse](../../sdk/models/cancel-schedule-response.md)\>**
|
|
1978
|
-
|
|
1979
|
-
### Errors
|
|
1980
|
-
|
|
1981
|
-
| Error Type | Status Code | Content Type |
|
|
1982
|
-
| --------------- | --------------- | --------------- |
|
|
1983
|
-
| models.SDKError | 4XX, 5XX | \*/\* |
|
|
1984
|
-
|
|
1985
|
-
## listSubscriptionSchedules
|
|
1984
|
+
## getSubscriptionV2
|
|
1986
1985
|
|
|
1987
|
-
Use when
|
|
1986
|
+
Use when you need a subscription with related data (line items, prices, plan). Supports expand for detailed payloads without extra round-trips.
|
|
1988
1987
|
|
|
1989
1988
|
### Example Usage
|
|
1990
1989
|
|
|
1991
|
-
<!-- UsageSnippet language="typescript" operationID="
|
|
1990
|
+
<!-- UsageSnippet language="typescript" operationID="getSubscriptionV2" method="get" path="/subscriptions/{id}/v2" -->
|
|
1992
1991
|
```typescript
|
|
1993
1992
|
import { Flexprice } from "@flexprice/sdk";
|
|
1994
1993
|
|
|
@@ -1997,7 +1996,7 @@ const flexprice = new Flexprice({
|
|
|
1997
1996
|
});
|
|
1998
1997
|
|
|
1999
1998
|
async function run() {
|
|
2000
|
-
const result = await flexprice.subscriptions.
|
|
1999
|
+
const result = await flexprice.subscriptions.getSubscriptionV2("<id>");
|
|
2001
2000
|
|
|
2002
2001
|
console.log(result);
|
|
2003
2002
|
}
|
|
@@ -2011,7 +2010,7 @@ The standalone function version of this method:
|
|
|
2011
2010
|
|
|
2012
2011
|
```typescript
|
|
2013
2012
|
import { FlexpriceCore } from "@flexprice/sdk/core.js";
|
|
2014
|
-
import {
|
|
2013
|
+
import { subscriptionsGetSubscriptionV2 } from "@flexprice/sdk/funcs/subscriptions-get-subscription-v2.js";
|
|
2015
2014
|
|
|
2016
2015
|
// Use `FlexpriceCore` for best tree-shaking performance.
|
|
2017
2016
|
// You can create one instance of it to use across an application.
|
|
@@ -2020,12 +2019,12 @@ const flexprice = new FlexpriceCore({
|
|
|
2020
2019
|
});
|
|
2021
2020
|
|
|
2022
2021
|
async function run() {
|
|
2023
|
-
const res = await
|
|
2022
|
+
const res = await subscriptionsGetSubscriptionV2(flexprice, "<id>");
|
|
2024
2023
|
if (res.ok) {
|
|
2025
2024
|
const { value: result } = res;
|
|
2026
2025
|
console.log(result);
|
|
2027
2026
|
} else {
|
|
2028
|
-
console.log("
|
|
2027
|
+
console.log("subscriptionsGetSubscriptionV2 failed:", res.error);
|
|
2029
2028
|
}
|
|
2030
2029
|
}
|
|
2031
2030
|
|
|
@@ -2036,17 +2035,20 @@ run();
|
|
|
2036
2035
|
|
|
2037
2036
|
| Parameter | Type | Required | Description |
|
|
2038
2037
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
2039
|
-
| `
|
|
2038
|
+
| `id` | *string* | :heavy_check_mark: | Subscription ID |
|
|
2039
|
+
| `expand` | *string* | :heavy_minus_sign: | Comma-separated list of fields to expand (e.g., 'subscription_line_items,prices,plan') |
|
|
2040
2040
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
2041
2041
|
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
2042
2042
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
2043
2043
|
|
|
2044
2044
|
### Response
|
|
2045
2045
|
|
|
2046
|
-
**Promise\<[models.
|
|
2046
|
+
**Promise\<[models.SubscriptionResponseV2](../../sdk/models/subscription-response-v2.md)\>**
|
|
2047
2047
|
|
|
2048
2048
|
### Errors
|
|
2049
2049
|
|
|
2050
|
-
| Error Type
|
|
2051
|
-
|
|
|
2052
|
-
| models.
|
|
2050
|
+
| Error Type | Status Code | Content Type |
|
|
2051
|
+
| -------------------------- | -------------------------- | -------------------------- |
|
|
2052
|
+
| models.ErrorsErrorResponse | 400 | application/json |
|
|
2053
|
+
| models.ErrorsErrorResponse | 500 | application/json |
|
|
2054
|
+
| models.SDKError | 4XX, 5XX | \*/\* |
|