{
"message": "The requested resource was not found",
"error": "not_found"
}
{
"message": "The requested resource was not found",
"error": "not_found"
}
{
"message": "The requested resource was not found",
"error": "not_found"
}
{
"message": "The requested resource was not found",
"error": "not_found"
}
{
"message": "The requested resource was not found",
"error": "not_found"
}
{
"message": "The requested resource was not found",
"error": "not_found"
}
Authorizations
Authorization
string
header
required
API key authentication
Body
application/json
name
string
required
Subscription identifier combining customer and service details. Sample values: 'TechCorp - LLM API Access', 'Analytics Co - Data Platform Enterprise', 'StartupXYZ - Image Generation Service', 'Enterprise Inc - ML Training Platform'
planId
string
required
Unique identifier for a plan
Pattern: ^plan_[a-zA-Z0-9]+$
startedAt
string<date-time>
required
Subscription activation timestamp in ISO 8601 format. Sample values: '2024-01-15T10:30:00Z', '2024-02-01T00:00:00Z'
autoCharge
boolean
default:false
Enable automatic charging of invoices using stored payment methods. When true, invoices will be automatically paid using off-session payment. Defaults to false.
taxExempt
boolean
default:false
When true, forces tax rate to 0%. Use for customers with verified tax-exempt status.
customer
object
Fields to create a new customer and consumer. Will use an existing consumer if one exists with the same email address. Required if customerId is not provided. Address with complete tax information (country, state, zipCode) is required for tax calculation when using Paygentic Tax.
Show child attributes
customerId
string
Unique identifier for a customer
Pattern: ^cus_[a-zA-Z0-9]+$
endingAt
string<date-time>
Subscription expiration timestamp in ISO 8601 format. Sample values: '2024-12-31T23:59:59Z', '2025-01-15T10:30:00Z'. Omit for indefinite subscriptions. Must be after startedAt: a value at or before it is rejected with 400.
prefundAmount
string
deprecated
Deprecated. This field is ignored and has no effect.
minimumAccountBalance
string
deprecated
Deprecated. This field is ignored and has no effect.
redirectUrls
object
Optional redirect URLs after payment completion or failure. If not provided, uses default platform behavior.
Show child attributes
elapsedPeriodBilling
enum<string>
default:none
Whether a backdated start bills its elapsed periods. A start is backdated when startedAt is more than 24 hours before the subscription is created. none bills only charges that fall due from the moment of creation, for a customer whose earlier periods another system already billed. per_period bills every charge that fell due from startedAt, on one first invoice; it refuses a startedAt more than 12 months back, with the code PER_PERIOD_LOOKBACK_EXCEEDED. Has no effect on a start that is not backdated. Defaults to none.
Available options:
none,
per_period
billingAnchor
string<date-time>
A billing anchor for this subscription, in place of the plan's. Any instant, past or future. The subscription's billing anchor is its first recurrence on or after startedAt, stepping back or forward by whole billing cadences. Example: on a monthly plan, an anchor of '2027-01-31T00:00:00Z' with a start of '2026-10-10T00:00:00Z' gives '2026-10-31T00:00:00Z'. A create is refused with 400 when the resolved anchor does not line up with the usage period anchor of a feature that credits unused balance. Omit it to use the plan's billing anchor. A repeated create that names an anchor resolving to a different instant than the existing subscription's gets 409.
testClockId
string
Test clock identifier for simulating time-based billing scenarios. Sample values: 'tc_abc123xyz', 'tc_789def456'. Restricted to non-production environments (local, dev, sandbox). Must belong to the same merchant organization.
renewalReminderEnabled
boolean | null
Override plan setting for renewal reminder emails. When set, this subscription's setting takes precedence over the plan default. Set to true to enable reminders, false to disable, or null/omit to use plan default.
renewalReminderDays
integer | null
Override plan setting for number of days before renewal to send the reminder. Only used if renewalReminderEnabled is true (or inherited from plan). Set to null to use plan default.
Required range: 1 <= x <= 30
paymentTermDays
integer
Payment term in days ("Net X") applied to every invoice the subscription generates: invoice dueAt = invoice issue date + paymentTermDays. Defaults to 0 ("due on issue"). Valid on any subscription, whatever its payment method. With a non-zero value Invoice 0's payment session expires at its due date, and sending sessionExpiryMinutes with it answers 400 SESSION_EXPIRY_NOT_ALLOWED_WITH_PAYMENT_TERM.
Required range: 0 <= x <= 365
sessionExpiryMinutes
number
Number of minutes until the payment session expires. Defaults to 240 minutes (4 hours) if not provided. Not accepted with a non-zero paymentTermDays: the session then expires at the invoice due date.
Required range: x >= 1
versionPolicy
enum<string>
How the subscription follows new versions of its plan. floating follows the plan's default version: when the default changes, the subscription bills from the new default from its next billing period. pinned keeps the plan version that the subscription holds. A subscription created without a value is floating. A change to this value does not change a billing period that has already started.
Available options:
floating,
pinned
metadata
object
Free-form merchant metadata to attach to the subscription. Values must be strings, numbers, or booleans.
Show child attributes
changeReason
enum<string>
Why a change was made. correction repairs data that was entered wrong; migration moves a contract from another system; commercial is a real change to the deal; contractual applies a step the original contract scheduled, such as an annual uplift. Defaults to unspecified.
Available options:
commercial,
correction,
migration,
unspecified,
contractual
changeDescription
string
A free-text note on why these intervals are changing.
Maximum string length: 1000
changeMetadata
object
Your own key-value data about the change, such as a CRM deal ID.
Show child attributes
addPrices
object[]
Catalog prices to bill on this subscription that its plan version does not carry. Each must be owned by the same merchant and use the standard price model.
Maximum array length: 25
Show child attributes
overridePrices
object[]
Rate or quantity overrides for prices the plan version does carry.
Maximum array length: 25
Show child attributes
removePrices
object[]
Plan prices this subscription does not bill.
Maximum array length: 25
Show child attributes
Response
Subscription already exists
id
string
required
object
enum<string>
required
Available options:
subscription
merchantId
string
required
The merchant organization that owns this subscription, equal to the customer's merchant.
Pattern: ^org_[a-zA-Z0-9]+$
createdAt
string<date-time>
required
customerId
string
required
name
string
required
planId
string
required
versionPolicy
enum<string>
required
How the subscription follows new versions of its plan. floating follows the plan's default version: when the default changes, the subscription bills from the new default from its next billing period. pinned keeps the plan version that the subscription holds. A subscription created without a value is floating. A change to this value does not change a billing period that has already started.
Available options:
floating,
pinned
startedAt
string<date-time>
required
elapsedPeriodBilling
enum<string> | null
required
Whether this subscription's backdated start bills its elapsed periods, as chosen at creation. null for a subscription created before the choice existed. null is listed in the enum as well as via nullable because the response validator checks the enum independently.
Available options:
none,
per_period,
null
billingStartsAt
string<date-time> | null
required
The billing start: a charge is billed only if it falls due at or after this moment. Fixed at creation and never changed. It is startedAt, unless the start was backdated with elapsedPeriodBilling of none, in which case it is the moment of creation.
billingAnchor
string<date-time>
required
The instant the subscription's billing periods are anchored on: its billing anchor, else its start. Every recurring period boundary is this instant plus a whole number of cadences.
billingCadence
string
required
The ISO-8601 duration the subscription's billing periods step by where no price sets its own: the subscription's cadence, else its plan's.
Example:
"P1M"
status
enum<string>
required
Available options:
pending_payment,
active,
terminated
updatedAt
string<date-time>
required
paymentTermDays
integer
required
Payment term in days ("Net X") snapshotted onto every invoice the subscription generates (invoice dueAt = invoice issue date + paymentTermDays). Defaults to 0 ("due on issue"); a non-zero value is valid on any subscription, whatever its payment method.
Required range: 0 <= x <= 365
autoCharge
boolean
default:false
Whether automatic charging is enabled for this subscription. When true, invoices will be automatically paid using stored payment methods.
Payment session details when upfront payment is required, or confirmation of a zero-amount paid invoice
Option 1
Option 2
Option 3
Show child attributes
planVersionId
string
The plan version pinned to this subscription at creation.
versionNumber
integer
The version number of the plan version referenced by planVersionId, as of subscription creation.
Required range: x >= 1
prefundAmount
string
deprecated
Deprecated. Legacy-only, not populated for new subscriptions.
minimumAccountBalance
string
deprecated
Deprecated. Legacy-only, not populated for new subscriptions.
terminatedAt
string<date-time>
terminatedBy
string
ID of who terminated the subscription (customer ID or merchant ID)
terminationReason
string
Reason for termination
terminationChangeReason
enum<string> | null
Why the subscription was terminated. Null while it is not terminated.
Available options:
commercial,
correction,
migration,
unspecified,
contractual,
null
testClockId
string
Test clock ID if this subscription is attached to a test clock. Only present in non-production environments.
walletId
string
deprecated
Deprecated. Legacy-only, not populated for new subscriptions.
renewalReminderEnabled
boolean | null
Whether renewal reminder emails are enabled for this subscription. Null means use plan default.
renewalReminderDays
integer | null
Number of days before renewal to send the reminder. Null means use plan default.
autoApprove
boolean | null
Subscription-level auto-approval override. Null means plan default is used.
metadata
object
Free-form merchant metadata to attach to the subscription. Values must be strings, numbers, or booleans.
Show child attributes
customer
object
Customer details with merchant and consumer information. Only included when include=customer is specified in the list query.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema.json","name":"Paygentic","colors":{"primary":"#013F70","light":"#E0B1F7","dark":"#FF6F57"},"logo":{"light":"https://mintcdn.com/paygentic/uUKYt4gDqyfhF9Y7/logo/paygentic-logo-light.svg?fit=max\u0026auto=format\u0026n=uUKYt4gDqyfhF9Y7\u0026q=85\u0026s=cb1fd6b59a3c44e357ecdc522849ab37","dark":"https://mintcdn.com/paygentic/uUKYt4gDqyfhF9Y7/logo/paygentic-logo-dark.svg?fit=max\u0026auto=format\u0026n=uUKYt4gDqyfhF9Y7\u0026q=85\u0026s=e472e905a55866be14a5e51b15f16db6"},"favicon":"https://mintcdn.com/paygentic/uUKYt4gDqyfhF9Y7/favicon.svg?fit=max\u0026auto=format\u0026n=uUKYt4gDqyfhF9Y7\u0026q=85\u0026s=a93d7819e80f48ee401156e695125f09","navbar":{"links":[{"href":"mailto:support@paygentic.io","label":"Support"}]},"fonts":{"heading":{"family":"Funnel Display"},"body":{"family":"Host Grotesk"}},"integrations":{"posthog":{"apiKey":"phc_DYYQW9UMuySBrmREkYbwieAfTzyvSpOJVFm1v9DQzyh","apiHost":"https://us.i.posthog.com"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paygentic","hasAudioNarration":false,"actualSubdomain":"paygentic","customDomains":["docs.paygentic.io"],"gitSource":{"type":"github","owner":"paygentic","repo":"paygentic","deployBranch":"main","contentDirectory":"projects/docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b027ed334aba046b8ae3628","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":161},{"language":"default","tag":"Documentation","count":42},{"language":"default","tag":"Platform","count":29},{"language":"default","tag":"Subscriptions","count":15},{"language":"default","tag":"Sources","count":14},{"language":"default","tag":"Invoices V2","count":12},{"language":"default","tag":"Billing","count":10},{"language":"default","tag":"Pricing","count":10},{"language":"default","tag":"Billing Schedules","count":9},{"language":"default","tag":"Orders","count":9}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[]}
{"page":{"pagePath":"api-reference/subscriptions/create","slug":"/api-reference/subscriptions/create","pageMetadata":{"title":"Create","description":"Creates a subscription for an existing customer or creates a new customer as part of the action.","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions","href":"/api-reference/subscriptions/create","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Creates a subscription for an existing customer or creates a new customer as part of the action.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create","description":"Creates a subscription for an existing customer or creates a new customer as part of the action.","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions","href":"/api-reference/subscriptions/create","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Subscriptions"],"summary":"Create","description":"Creates a subscription for an existing customer or creates a new customer as part of the action.","operationId":"createSubscription","requestBody":"0b222e2b-3250-4516-afef-b99b802bc649","responses":{"200":"4263883e-a52a-4640-8bc0-86ffde74eb23","201":"c257a707-647f-469e-98e1-f59c72ff639f","400":"50db8565-d359-4abf-9e61-02a134a1bccf","401":"26bb10bf-df84-4d1d-bb18-2512b51c0f11","403":"7801fadf-7b83-4c61-b2fb-f2de0d11dfa7","404":"381c0313-d617-461a-83f3-4b9a803e9e1e","409":"03346b2f-8553-4f16-9a2e-ace1ba33742e","500":"80a69e8a-d6e7-4232-95e6-589d742b0473"},"x-permission":"subscriptions:write","method":"post","type":"path","servers":["7498f67e-c06f-4d11-9a4e-7c43f0f53b26","d0f74462-aeec-4209-82f4-dbb60498c1a2"],"security":["341ede1c-db03-4e32-b951-0c478552f430"],"path":"/v0/subscriptions","baseUrlOptions":["https://api.paygentic.io","https://api.sandbox.paygentic.io"],"title":"Create","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["planId","name","startedAt"],"properties":{"name":{"type":"string","description":"Subscription identifier combining customer and service details. Sample values: 'TechCorp - LLM API Access', 'Analytics Co - Data Platform Enterprise', 'StartupXYZ - Image Generation Service', 'Enterprise Inc - ML Training Platform'","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"planId":{"type":"string","pattern":"^plan_[a-zA-Z0-9]+$","description":"Unique identifier for a plan","isRequired":true,"uniqueKey":"planId","typeLabel":"string"},"startedAt":{"type":"string","format":"date-time","description":"Subscription activation timestamp in ISO 8601 format. Sample values: '2024-01-15T10:30:00Z', '2024-02-01T00:00:00Z'","isRequired":true,"uniqueKey":"startedAt","typeLabel":"string\u003cdate-time>"},"autoCharge":{"type":"boolean","description":"Enable automatic charging of invoices using stored payment methods. When true, invoices will be automatically paid using off-session payment. Defaults to false.","default":false,"uniqueKey":"autoCharge","typeLabel":"boolean"},"taxExempt":{"type":"boolean","description":"When true, forces tax rate to 0%. Use for customers with verified tax-exempt status.","default":false,"uniqueKey":"taxExempt","typeLabel":"boolean"},"customer":{"type":"object","description":"Fields to create a new customer and consumer. Will use an existing consumer if one exists with the same email address. Required if `customerId` is not provided. Address with complete tax information (country, state, zipCode) is required for tax calculation when using Paygentic Tax.","properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"customer.name","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"customer.email","typeLabel":"string"},"address":{"type":"object","description":"Address is required for tax calculation. Must include: country (ISO 3166-1 alpha-2) and zipCode. The state/region field is required and validated for US/CA addresses only (custom validation in API logic). Postal code format is not validated but will be normalized.","required":["country","zipCode"],"properties":{"country":{"type":"string","minLength":2,"maxLength":2,"description":"2 character ISO 3166 country code","isRequired":true,"uniqueKey":"customer.address.country","typeLabel":"string"},"zipCode":{"type":"string","isRequired":true,"uniqueKey":"customer.address.zipCode","typeLabel":"string"},"line1":{"type":"string","uniqueKey":"customer.address.line1","typeLabel":"string"},"line2":{"type":"string","uniqueKey":"customer.address.line2","typeLabel":"string"},"city":{"type":"string","uniqueKey":"customer.address.city","typeLabel":"string"},"state":{"type":"string","uniqueKey":"customer.address.state","typeLabel":"string"}},"isRequired":true,"uniqueKey":"customer.address","typeLabel":"object"},"phone":{"type":"string","uniqueKey":"customer.phone","typeLabel":"string"},"taxRates":{"type":"object","description":"An object mapping plan IDs, metric IDs, or 'default' to a tax rate percentage (e.g., 13 for 13%)","additionalProperties":{"type":"number","minimum":0,"maximum":100,"uniqueKey":"customer.taxRates.additionalProperties","typeLabel":"number"},"uniqueKey":"customer.taxRates","typeLabel":"object"}},"required":["name","email","address"],"uniqueKey":"customer","typeLabel":"object"},"customerId":{"type":"string","pattern":"^cus_[a-zA-Z0-9]+$","description":"Unique identifier for a customer","uniqueKey":"customerId","typeLabel":"string"},"endingAt":{"type":"string","format":"date-time","description":"Subscription expiration timestamp in ISO 8601 format. Sample values: '2024-12-31T23:59:59Z', '2025-01-15T10:30:00Z'. Omit for indefinite subscriptions. Must be after startedAt: a value at or before it is rejected with 400.","uniqueKey":"endingAt","typeLabel":"string\u003cdate-time>"},"prefundAmount":{"type":"string","deprecated":true,"description":"Deprecated. This field is ignored and has no effect.","uniqueKey":"prefundAmount","typeLabel":"string"},"minimumAccountBalance":{"type":"string","deprecated":true,"description":"Deprecated. This field is ignored and has no effect.","uniqueKey":"minimumAccountBalance","typeLabel":"string"},"redirectUrls":{"type":"object","description":"Optional redirect URLs after payment completion or failure. If not provided, uses default platform behavior.","properties":{"onSuccess":{"type":"string","format":"uri","description":"Redirect destination after successful payment. Sample values: 'https://app.example.com/success', 'https://dashboard.company.com/welcome', 'https://portal.startup.io/complete'","uniqueKey":"redirectUrls.onSuccess","typeLabel":"string\u003curi>"},"onFailure":{"type":"string","format":"uri","description":"Redirect destination after failed payment. Sample values: 'https://app.example.com/payment-failed', 'https://dashboard.company.com/retry', 'https://portal.startup.io/error'","uniqueKey":"redirectUrls.onFailure","typeLabel":"string\u003curi>"}},"uniqueKey":"redirectUrls","typeLabel":"object"},"elapsedPeriodBilling":{"type":"string","enum":["none","per_period"],"default":"none","description":"Whether a backdated start bills its elapsed periods. A start is backdated when `startedAt` is more than 24 hours before the subscription is created. `none` bills only charges that fall due from the moment of creation, for a customer whose earlier periods another system already billed. `per_period` bills every charge that fell due from `startedAt`, on one first invoice; it refuses a `startedAt` more than 12 months back, with the code `PER_PERIOD_LOOKBACK_EXCEEDED`. Has no effect on a start that is not backdated. Defaults to `none`.","uniqueKey":"elapsedPeriodBilling","typeLabel":"enum\u003cstring>"},"billingAnchor":{"type":"string","format":"date-time","description":"A billing anchor for this subscription, in place of the plan's. Any instant, past or future. The subscription's billing anchor is its first recurrence on or after `startedAt`, stepping back or forward by whole billing cadences. Example: on a monthly plan, an anchor of '2027-01-31T00:00:00Z' with a start of '2026-10-10T00:00:00Z' gives '2026-10-31T00:00:00Z'. A create is refused with 400 when the resolved anchor does not line up with the usage period anchor of a feature that credits unused balance. Omit it to use the plan's billing anchor. A repeated create that names an anchor resolving to a different instant than the existing subscription's gets 409.","uniqueKey":"billingAnchor","typeLabel":"string\u003cdate-time>"},"testClockId":{"type":"string","description":"Test clock identifier for simulating time-based billing scenarios. Sample values: 'tc_abc123xyz', 'tc_789def456'. Restricted to non-production environments (local, dev, sandbox). Must belong to the same merchant organization.","uniqueKey":"testClockId","typeLabel":"string"},"renewalReminderEnabled":{"oneOf":[{"type":"boolean","description":"Override plan setting for renewal reminder emails. When set, this subscription's setting takes precedence over the plan default. Set to true to enable reminders, false to disable, or null/omit to use plan default.","uniqueKey":"renewalReminderEnabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Override plan setting for renewal reminder emails. When set, this subscription's setting takes precedence over the plan default. Set to true to enable reminders, false to disable, or null/omit to use plan default.","uniqueKey":"renewalReminderEnabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"renewalReminderEnabled","typeLabel":"boolean | null"},"renewalReminderDays":{"oneOf":[{"type":"integer","description":"Override plan setting for number of days before renewal to send the reminder. Only used if renewalReminderEnabled is true (or inherited from plan). Set to null to use plan default.","minimum":1,"maximum":30,"uniqueKey":"renewalReminderDays.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Override plan setting for number of days before renewal to send the reminder. Only used if renewalReminderEnabled is true (or inherited from plan). Set to null to use plan default.","minimum":1,"maximum":30,"uniqueKey":"renewalReminderDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"renewalReminderDays","typeLabel":"integer | null"},"paymentTermDays":{"type":"integer","description":"Payment term in days (\"Net X\") applied to every invoice the subscription generates: invoice dueAt = invoice issue date + paymentTermDays. Defaults to 0 (\"due on issue\"). Valid on any subscription, whatever its payment method. With a non-zero value Invoice 0's payment session expires at its due date, and sending `sessionExpiryMinutes` with it answers 400 `SESSION_EXPIRY_NOT_ALLOWED_WITH_PAYMENT_TERM`.","minimum":0,"maximum":365,"uniqueKey":"paymentTermDays","typeLabel":"integer"},"sessionExpiryMinutes":{"type":"number","description":"Number of minutes until the payment session expires. Defaults to 240 minutes (4 hours) if not provided. Not accepted with a non-zero `paymentTermDays`: the session then expires at the invoice due date.","minimum":1,"uniqueKey":"sessionExpiryMinutes","typeLabel":"number"},"versionPolicy":{"type":"string","enum":["floating","pinned"],"description":"How the subscription follows new versions of its plan. `floating` follows the plan's default version: when the default changes, the subscription bills from the new default from its next billing period. `pinned` keeps the plan version that the subscription holds. A subscription created without a value is `floating`. A change to this value does not change a billing period that has already started.","uniqueKey":"versionPolicy","typeLabel":"enum\u003cstring>"},"metadata":{"type":"object","description":"Free-form merchant metadata to attach to the subscription. Values must be strings, numbers, or booleans.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"metadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"metadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"metadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"metadata","typeLabel":"object"},"changeReason":{"type":"string","enum":["commercial","correction","migration","unspecified","contractual"],"x-speakeasy-unknown-values":"allow","description":"Why a change was made. `correction` repairs data that was entered wrong; `migration` moves a contract from another system; `commercial` is a real change to the deal; `contractual` applies a step the original contract scheduled, such as an annual uplift. Defaults to `unspecified`.","uniqueKey":"changeReason","typeLabel":"enum\u003cstring>"},"changeDescription":{"type":"string","maxLength":1000,"description":"A free-text note on why these intervals are changing.","uniqueKey":"changeDescription","typeLabel":"string"},"changeMetadata":{"type":"object","description":"Your own key-value data about the change, such as a CRM deal ID.","maxProperties":50,"propertyNames":{"maxLength":100},"additionalProperties":{"oneOf":[{"type":"string","maxLength":500,"uniqueKey":"changeMetadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","maxLength":500,"uniqueKey":"changeMetadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","maxLength":500,"uniqueKey":"changeMetadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"changeMetadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"changeMetadata","typeLabel":"object"},"addPrices":{"type":"array","maxItems":25,"items":{"type":"object","additionalProperties":false,"required":["priceId"],"description":"A catalog price the plan version does not carry. The rate is always stored on the interval, because an added price has no plan slot and so version copy-on-write never freezes a snapshot for it. Omit unitPrice to store the named price's own rate; supply one to store a negotiated rate instead. Supply total and installments instead to collect one obligation over several billing periods.","properties":{"priceId":{"type":"string","description":"The catalog price to bill. Must belong to the subscription's merchant and must not already be carried by the plan version.","isRequired":true,"uniqueKey":"addPrices.items.[INDEX].priceId","typeLabel":"string"},"unitPrice":{"type":"string","description":"The agreed rate, as a decimal string. Defaults to the named price's own rate. Cannot be combined with total.","uniqueKey":"addPrices.items.[INDEX].unitPrice","typeLabel":"string"},"baseQuantity":{"type":"string","description":"Quantity to bill. Defaults to the catalog price's own quantity. Cannot be combined with total.","uniqueKey":"addPrices.items.[INDEX].baseQuantity","typeLabel":"string"},"total":{"type":"string","pattern":"^(0|[1-9]\\d*)(\\.\\d+)?$","maxLength":21,"description":"The whole contract amount to collect as equal installments, as a positive decimal string in plain notation. With installments it must divide into equal amounts at two decimal places; beside amounts it is an optional checksum that must equal their exact sum. The named price must be an obligation carrying quantity 1 on the subscription's own billing cadence. Recorded on the interval exactly as written, so an exponent, a sign, a radix prefix or a leading-zero run is rejected rather than normalized.","uniqueKey":"addPrices.items.[INDEX].total","typeLabel":"string"},"installments":{"type":"integer","minimum":2,"maximum":60,"description":"How many billing periods the total is collected over, producing equal installments. Requires total, and cannot accompany amounts. One installment is one billing period of the subscription, so a count of 3 on an annual subscription runs three years. The window is derived from the subscription's billing grid; no date is accepted.","uniqueKey":"addPrices.items.[INDEX].installments","typeLabel":"integer"},"amounts":{"type":"array","minItems":2,"maxItems":60,"items":{"type":"string","uniqueKey":"addPrices.items.[INDEX].amounts.items.[INDEX]","typeLabel":"string"},"description":"The installment schedule stated explicitly: one positive decimal amount per billing period, in order, each in plain notation with at most 2 decimal places. The amounts need not be equal, and their exact sum is the contract total; a total supplied alongside acts as a checksum and must equal that sum. Cannot accompany installments, unitPrice, baseQuantity, or any date: the window is derived in full from the subscription's billing grid. Use this shape when the contract's split is not equal - for example 2950.00 in three monthly instalments of 984.00, 983.00 and 983.00.","uniqueKey":"addPrices.items.[INDEX].amounts","typeLabel":"string[]"}},"uniqueKey":"addPrices.items.[INDEX]","typeLabel":"object"},"description":"Catalog prices to bill on this subscription that its plan version does not carry. Each must be owned by the same merchant and use the standard price model.","uniqueKey":"addPrices","typeLabel":"object[]"},"overridePrices":{"type":"array","maxItems":25,"items":{"type":"object","additionalProperties":false,"description":"A rate or quantity override for a price the plan version carries. Supply at least one of unitPrice or baseQuantity; a request supplying neither is rejected with a 400 naming the entry.","required":["overridesPriceId"],"properties":{"overridesPriceId":{"type":"string","description":"The plan-version price being overridden. Its priceKey lineage is preserved.","isRequired":true,"uniqueKey":"overridePrices.items.[INDEX].overridesPriceId","typeLabel":"string"},"unitPrice":{"type":"string","description":"The agreed rate, as a decimal string.","uniqueKey":"overridePrices.items.[INDEX].unitPrice","typeLabel":"string"},"baseQuantity":{"type":"string","description":"The agreed quantity, as a decimal string.","uniqueKey":"overridePrices.items.[INDEX].baseQuantity","typeLabel":"string"}},"uniqueKey":"overridePrices.items.[INDEX]","typeLabel":"object"},"description":"Rate or quantity overrides for prices the plan version does carry.","uniqueKey":"overridePrices","typeLabel":"object[]"},"removePrices":{"type":"array","maxItems":25,"items":{"type":"object","additionalProperties":false,"required":["priceId"],"properties":{"priceId":{"type":"string","description":"The plan-version price this subscription does not bill.","isRequired":true,"uniqueKey":"removePrices.items.[INDEX].priceId","typeLabel":"string"}},"uniqueKey":"removePrices.items.[INDEX]","typeLabel":"object"},"description":"Plan prices this subscription does not bill.","uniqueKey":"removePrices","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","planId":"\u003cstring>","startedAt":"2023-11-07T05:31:56Z","autoCharge":false,"taxExempt":false,"customerId":"\u003cstring>","endingAt":"2023-11-07T05:31:56Z","prefundAmount":"\u003cstring>","minimumAccountBalance":"\u003cstring>","redirectUrls":{"onSuccess":"\u003cstring>","onFailure":"\u003cstring>"},"elapsedPeriodBilling":"none","billingAnchor":"2023-11-07T05:31:56Z","testClockId":"\u003cstring>","renewalReminderEnabled":true,"renewalReminderDays":15,"paymentTermDays":182,"sessionExpiryMinutes":2,"metadata":{},"changeDescription":"\u003cstring>","changeMetadata":{},"addPrices":[{"priceId":"\u003cstring>","unitPrice":"\u003cstring>","baseQuantity":"\u003cstring>","total":"\u003cstring>","installments":31,"amounts":["\u003cstring>"]}],"overridePrices":[{"overridesPriceId":"\u003cstring>","unitPrice":"\u003cstring>","baseQuantity":"\u003cstring>"}],"removePrices":[{"priceId":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"4263883e-a52a-4640-8bc0-86ffde74eb23":{"description":"Subscription already exists","content":{"application/json":{"schema":{"type":"object","required":["id","object","merchantId","name","customerId","planId","status","startedAt","billingAnchor","billingCadence","createdAt","updatedAt","paymentTermDays","versionPolicy","elapsedPeriodBilling","billingStartsAt"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","enum":["subscription"],"isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"merchantId":{"type":"string","pattern":"^org_[a-zA-Z0-9]+$","description":"The merchant organization that owns this subscription, equal to the customer's merchant.","isRequired":true,"uniqueKey":"merchantId","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"customerId":{"type":"string","isRequired":true,"uniqueKey":"customerId","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"planId":{"type":"string","isRequired":true,"uniqueKey":"planId","typeLabel":"string"},"versionPolicy":{"type":"string","enum":["floating","pinned"],"description":"How the subscription follows new versions of its plan. `floating` follows the plan's default version: when the default changes, the subscription bills from the new default from its next billing period. `pinned` keeps the plan version that the subscription holds. A subscription created without a value is `floating`. A change to this value does not change a billing period that has already started.","isRequired":true,"uniqueKey":"versionPolicy","typeLabel":"enum\u003cstring>"},"startedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"startedAt","typeLabel":"string\u003cdate-time>"},"elapsedPeriodBilling":{"oneOf":[{"type":"string","enum":["none","per_period",null],"description":"Whether this subscription's backdated start bills its elapsed periods, as chosen at creation. `null` for a subscription created before the choice existed. `null` is listed in the enum as well as via `nullable` because the response validator checks the enum independently.","isRequired":true,"uniqueKey":"elapsedPeriodBilling.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["none","per_period",null],"description":"Whether this subscription's backdated start bills its elapsed periods, as chosen at creation. `null` for a subscription created before the choice existed. `null` is listed in the enum as well as via `nullable` because the response validator checks the enum independently.","isRequired":true,"uniqueKey":"elapsedPeriodBilling.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"elapsedPeriodBilling","typeLabel":"enum\u003cstring> | null"},"billingStartsAt":{"oneOf":[{"type":"string","format":"date-time","description":"The billing start: a charge is billed only if it falls due at or after this moment. Fixed at creation and never changed. It is `startedAt`, unless the start was backdated with `elapsedPeriodBilling` of `none`, in which case it is the moment of creation.","isRequired":true,"uniqueKey":"billingStartsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The billing start: a charge is billed only if it falls due at or after this moment. Fixed at creation and never changed. It is `startedAt`, unless the start was backdated with `elapsedPeriodBilling` of `none`, in which case it is the moment of creation.","isRequired":true,"uniqueKey":"billingStartsAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"billingStartsAt","typeLabel":"string\u003cdate-time> | null"},"billingAnchor":{"type":"string","format":"date-time","description":"The instant the subscription's billing periods are anchored on: its billing anchor, else its start. Every recurring period boundary is this instant plus a whole number of cadences.","isRequired":true,"uniqueKey":"billingAnchor","typeLabel":"string\u003cdate-time>"},"billingCadence":{"type":"string","description":"The ISO-8601 duration the subscription's billing periods step by where no price sets its own: the subscription's cadence, else its plan's.","example":"P1M","isRequired":true,"uniqueKey":"billingCadence","typeLabel":"string"},"status":{"type":"string","enum":["pending_payment","active","terminated"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"paymentTermDays":{"type":"integer","description":"Payment term in days (\"Net X\") snapshotted onto every invoice the subscription generates (invoice dueAt = invoice issue date + paymentTermDays). Defaults to 0 (\"due on issue\"); a non-zero value is valid on any subscription, whatever its payment method.","minimum":0,"maximum":365,"isRequired":true,"uniqueKey":"paymentTermDays","typeLabel":"integer"},"autoCharge":{"type":"boolean","description":"Whether automatic charging is enabled for this subscription. When true, invoices will be automatically paid using stored payment methods.","default":false,"uniqueKey":"autoCharge","typeLabel":"boolean"},"endingAt":{"type":"string","format":"date-time","uniqueKey":"endingAt","typeLabel":"string\u003cdate-time>"},"estimatedTaxRate":{"type":"number","description":"Projected tax percentage rate. Sample values: 8.875 indicates 8.875% tax rate, 10.0 indicates 10% tax rate, 0 indicates no tax applied","uniqueKey":"estimatedTaxRate","typeLabel":"number"},"taxExempt":{"type":"boolean","description":"When true, tax rate is forced to 0%.","default":false,"uniqueKey":"taxExempt","typeLabel":"boolean"},"payment":{"oneOf":[{"type":"object","description":"Payment session details when upfront payment is required, or confirmation of a zero-amount paid invoice","required":["paymentSessionId","checkoutUrl","amount","status","breakdown"],"properties":{"amount":{"type":"string","description":"Total payment amount in decimal dollar format. Sample values: '250.00' equals $250.00, '99.99' equals $99.99","isRequired":true,"uniqueKey":"payment.oneOf.0.amount","typeLabel":"string"},"breakdown":{"type":"object","description":"Breakdown of payment amount","properties":{"upfrontCharges":{"type":"string","description":"One-time flat fee charges in decimal dollar format. Sample values: '50.00' equals $50.00 setup fee, '100.00' equals $100.00 activation fee","isRequired":true,"uniqueKey":"payment.oneOf.0.breakdown.upfrontCharges","typeLabel":"string"},"walletCharge":{"type":"string","description":"Wallet charge amount in decimal dollar format.","isRequired":true,"uniqueKey":"payment.oneOf.0.breakdown.walletCharge","typeLabel":"string"}},"required":["upfrontCharges","walletCharge"],"isRequired":true,"uniqueKey":"payment.oneOf.0.breakdown","typeLabel":"object"},"checkoutUrl":{"type":"string","description":"Checkout page URL for customer payment completion.","isRequired":true,"uniqueKey":"payment.oneOf.0.checkoutUrl","typeLabel":"string"},"paymentSessionId":{"type":"string","description":"Payment session identifier for upfront payment processing.","isRequired":true,"uniqueKey":"payment.oneOf.0.paymentSessionId","typeLabel":"string"},"status":{"type":"string","description":"Payment status","enum":["pending"],"isRequired":true,"uniqueKey":"payment.oneOf.0.status","typeLabel":"enum\u003cstring>"},"invoiceId":{"type":"string","description":"ID of the invoice linked to this payment.","uniqueKey":"payment.oneOf.0.invoiceId","typeLabel":"string"}},"uniqueKey":"payment.oneOf.0","typeLabel":"object"},{"type":"object","description":"Payment session details when upfront payment is required, or confirmation of a zero-amount paid invoice","required":["invoiceId","amount","status"],"properties":{"invoiceId":{"type":"string","description":"The Invoice 0 id","isRequired":true,"uniqueKey":"payment.oneOf.1.invoiceId","typeLabel":"string"},"amount":{"type":"string","description":"Payment amount ('0' for zero-amount subscriptions)","isRequired":true,"uniqueKey":"payment.oneOf.1.amount","typeLabel":"string"},"status":{"type":"string","description":"Payment status","enum":["paid"],"isRequired":true,"uniqueKey":"payment.oneOf.1.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"payment.oneOf.1","typeLabel":"object"},{"type":"object","description":"Payment session details when upfront payment is required, or confirmation of a zero-amount paid invoice","required":["invoiceId","amount","status"],"properties":{"invoiceId":{"type":"string","description":"The Invoice 0 id awaiting approval","isRequired":true,"uniqueKey":"payment.oneOf.2.invoiceId","typeLabel":"string"},"amount":{"type":"string","description":"Total payment amount in decimal dollar format","isRequired":true,"uniqueKey":"payment.oneOf.2.amount","typeLabel":"string"},"status":{"type":"string","description":"Payment status","enum":["awaiting_approval"],"isRequired":true,"uniqueKey":"payment.oneOf.2.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"payment.oneOf.2","typeLabel":"object"}],"uniqueKey":"payment","typeLabel":"object"},"planVersionId":{"type":"string","description":"The plan version pinned to this subscription at creation.","uniqueKey":"planVersionId","typeLabel":"string"},"versionNumber":{"type":"integer","minimum":1,"description":"The version number of the plan version referenced by planVersionId, as of subscription creation.","uniqueKey":"versionNumber","typeLabel":"integer"},"prefundAmount":{"type":"string","deprecated":true,"description":"Deprecated. Legacy-only, not populated for new subscriptions.","uniqueKey":"prefundAmount","typeLabel":"string"},"minimumAccountBalance":{"type":"string","deprecated":true,"description":"Deprecated. Legacy-only, not populated for new subscriptions.","uniqueKey":"minimumAccountBalance","typeLabel":"string"},"terminatedAt":{"type":"string","format":"date-time","uniqueKey":"terminatedAt","typeLabel":"string\u003cdate-time>"},"terminatedBy":{"type":"string","description":"ID of who terminated the subscription (customer ID or merchant ID)","uniqueKey":"terminatedBy","typeLabel":"string"},"terminationReason":{"type":"string","description":"Reason for termination","uniqueKey":"terminationReason","typeLabel":"string"},"terminationChangeReason":{"oneOf":[{"type":"string","enum":["commercial","correction","migration","unspecified","contractual",null],"x-speakeasy-unknown-values":"allow","description":"Why the subscription was terminated. Null while it is not terminated.","uniqueKey":"terminationChangeReason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["commercial","correction","migration","unspecified","contractual",null],"x-speakeasy-unknown-values":"allow","description":"Why the subscription was terminated. Null while it is not terminated.","uniqueKey":"terminationChangeReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"terminationChangeReason","typeLabel":"enum\u003cstring> | null"},"testClockId":{"type":"string","description":"Test clock ID if this subscription is attached to a test clock. Only present in non-production environments.","uniqueKey":"testClockId","typeLabel":"string"},"walletId":{"type":"string","deprecated":true,"description":"Deprecated. Legacy-only, not populated for new subscriptions.","uniqueKey":"walletId","typeLabel":"string"},"renewalReminderEnabled":{"oneOf":[{"type":"boolean","description":"Whether renewal reminder emails are enabled for this subscription. Null means use plan default.","uniqueKey":"renewalReminderEnabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether renewal reminder emails are enabled for this subscription. Null means use plan default.","uniqueKey":"renewalReminderEnabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"renewalReminderEnabled","typeLabel":"boolean | null"},"renewalReminderDays":{"oneOf":[{"type":"integer","description":"Number of days before renewal to send the reminder. Null means use plan default.","uniqueKey":"renewalReminderDays.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Number of days before renewal to send the reminder. Null means use plan default.","uniqueKey":"renewalReminderDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"renewalReminderDays","typeLabel":"integer | null"},"autoApprove":{"oneOf":[{"type":"boolean","description":"Subscription-level auto-approval override. Null means plan default is used.","uniqueKey":"autoApprove.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Subscription-level auto-approval override. Null means plan default is used.","uniqueKey":"autoApprove.oneOf.1","typeLabel":"null"}],"uniqueKey":"autoApprove","typeLabel":"boolean | null"},"metadata":{"type":"object","description":"Free-form merchant metadata to attach to the subscription. Values must be strings, numbers, or booleans.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"metadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"metadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"metadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"metadata","typeLabel":"object"},"customer":{"type":"object","description":"Customer details with merchant and consumer information. Only included when include=customer is specified in the list query.","properties":{"id":{"type":"string","description":"Customer ID","uniqueKey":"customer.id","typeLabel":"string"},"merchantId":{"type":"string","description":"Merchant organization ID","uniqueKey":"customer.merchantId","typeLabel":"string"},"merchant":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"customer.merchant.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"customer.merchant.name","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"customer.merchant.email","typeLabel":"string"}},"required":["id","name","email"],"uniqueKey":"customer.merchant","typeLabel":"object"},"consumer":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"customer.consumer.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"customer.consumer.name","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"customer.consumer.email","typeLabel":"string"}},"required":["id","name","email"],"uniqueKey":"customer.consumer","typeLabel":"object"}},"uniqueKey":"customer","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"sub_z1a2b3c4d5e6f7g8","object":"subscription","versionPolicy":"floating","autoCharge":false,"taxExempt":false,"createdAt":"2024-01-10T08:00:00Z","customerId":"cus_q3r4s5t6u7v8w9x0","endingAt":null,"estimatedTaxRate":8.5,"name":"StartupXYZ - Image Generation Service","payment":null,"planId":"plan_t9u0v1w2x3y4z5a6","startedAt":"2024-01-10T08:00:00Z","elapsedPeriodBilling":"none","billingStartsAt":"2024-01-10T08:00:00Z","billingAnchor":"2024-01-10T08:00:00Z","billingCadence":"P1M","status":"active","terminatedAt":null,"terminatedBy":null,"terminationReason":null,"updatedAt":"2024-01-10T08:00:00Z"},"examples":{"Example":{"title":"Example","value":{"id":"sub_z1a2b3c4d5e6f7g8","object":"subscription","versionPolicy":"floating","autoCharge":false,"taxExempt":false,"createdAt":"2024-01-10T08:00:00Z","customerId":"cus_q3r4s5t6u7v8w9x0","endingAt":null,"estimatedTaxRate":8.5,"name":"StartupXYZ - Image Generation Service","payment":null,"planId":"plan_t9u0v1w2x3y4z5a6","startedAt":"2024-01-10T08:00:00Z","elapsedPeriodBilling":"none","billingStartsAt":"2024-01-10T08:00:00Z","billingAnchor":"2024-01-10T08:00:00Z","billingCadence":"P1M","status":"active","terminatedAt":null,"terminatedBy":null,"terminationReason":null,"updatedAt":"2024-01-10T08:00:00Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"c257a707-647f-469e-98e1-f59c72ff639f":{"description":"Subscription created successfully","content":{"application/json":{"schema":{"type":"object","required":["id","object","merchantId","name","customerId","planId","status","startedAt","billingAnchor","billingCadence","createdAt","updatedAt","paymentTermDays","versionPolicy","elapsedPeriodBilling","billingStartsAt"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","enum":["subscription"],"isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"merchantId":{"type":"string","pattern":"^org_[a-zA-Z0-9]+$","description":"The merchant organization that owns this subscription, equal to the customer's merchant.","isRequired":true,"uniqueKey":"merchantId","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"customerId":{"type":"string","isRequired":true,"uniqueKey":"customerId","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"planId":{"type":"string","isRequired":true,"uniqueKey":"planId","typeLabel":"string"},"versionPolicy":{"type":"string","enum":["floating","pinned"],"description":"How the subscription follows new versions of its plan. `floating` follows the plan's default version: when the default changes, the subscription bills from the new default from its next billing period. `pinned` keeps the plan version that the subscription holds. A subscription created without a value is `floating`. A change to this value does not change a billing period that has already started.","isRequired":true,"uniqueKey":"versionPolicy","typeLabel":"enum\u003cstring>"},"startedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"startedAt","typeLabel":"string\u003cdate-time>"},"elapsedPeriodBilling":{"oneOf":[{"type":"string","enum":["none","per_period",null],"description":"Whether this subscription's backdated start bills its elapsed periods, as chosen at creation. `null` for a subscription created before the choice existed. `null` is listed in the enum as well as via `nullable` because the response validator checks the enum independently.","isRequired":true,"uniqueKey":"elapsedPeriodBilling.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["none","per_period",null],"description":"Whether this subscription's backdated start bills its elapsed periods, as chosen at creation. `null` for a subscription created before the choice existed. `null` is listed in the enum as well as via `nullable` because the response validator checks the enum independently.","isRequired":true,"uniqueKey":"elapsedPeriodBilling.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"elapsedPeriodBilling","typeLabel":"enum\u003cstring> | null"},"billingStartsAt":{"oneOf":[{"type":"string","format":"date-time","description":"The billing start: a charge is billed only if it falls due at or after this moment. Fixed at creation and never changed. It is `startedAt`, unless the start was backdated with `elapsedPeriodBilling` of `none`, in which case it is the moment of creation.","isRequired":true,"uniqueKey":"billingStartsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The billing start: a charge is billed only if it falls due at or after this moment. Fixed at creation and never changed. It is `startedAt`, unless the start was backdated with `elapsedPeriodBilling` of `none`, in which case it is the moment of creation.","isRequired":true,"uniqueKey":"billingStartsAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"billingStartsAt","typeLabel":"string\u003cdate-time> | null"},"billingAnchor":{"type":"string","format":"date-time","description":"The instant the subscription's billing periods are anchored on: its billing anchor, else its start. Every recurring period boundary is this instant plus a whole number of cadences.","isRequired":true,"uniqueKey":"billingAnchor","typeLabel":"string\u003cdate-time>"},"billingCadence":{"type":"string","description":"The ISO-8601 duration the subscription's billing periods step by where no price sets its own: the subscription's cadence, else its plan's.","example":"P1M","isRequired":true,"uniqueKey":"billingCadence","typeLabel":"string"},"status":{"type":"string","enum":["pending_payment","active","terminated"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"paymentTermDays":{"type":"integer","description":"Payment term in days (\"Net X\") snapshotted onto every invoice the subscription generates (invoice dueAt = invoice issue date + paymentTermDays). Defaults to 0 (\"due on issue\"); a non-zero value is valid on any subscription, whatever its payment method.","minimum":0,"maximum":365,"isRequired":true,"uniqueKey":"paymentTermDays","typeLabel":"integer"},"autoCharge":{"type":"boolean","description":"Whether automatic charging is enabled for this subscription. When true, invoices will be automatically paid using stored payment methods.","default":false,"uniqueKey":"autoCharge","typeLabel":"boolean"},"endingAt":{"type":"string","format":"date-time","uniqueKey":"endingAt","typeLabel":"string\u003cdate-time>"},"estimatedTaxRate":{"type":"number","description":"Projected tax percentage rate. Sample values: 8.875 indicates 8.875% tax rate, 10.0 indicates 10% tax rate, 0 indicates no tax applied","uniqueKey":"estimatedTaxRate","typeLabel":"number"},"taxExempt":{"type":"boolean","description":"When true, tax rate is forced to 0%.","default":false,"uniqueKey":"taxExempt","typeLabel":"boolean"},"payment":{"oneOf":[{"type":"object","description":"Payment session details when upfront payment is required, or confirmation of a zero-amount paid invoice","required":["paymentSessionId","checkoutUrl","amount","status","breakdown"],"properties":{"amount":{"type":"string","description":"Total payment amount in decimal dollar format. Sample values: '250.00' equals $250.00, '99.99' equals $99.99","isRequired":true,"uniqueKey":"payment.oneOf.0.amount","typeLabel":"string"},"breakdown":{"type":"object","description":"Breakdown of payment amount","properties":{"upfrontCharges":{"type":"string","description":"One-time flat fee charges in decimal dollar format. Sample values: '50.00' equals $50.00 setup fee, '100.00' equals $100.00 activation fee","isRequired":true,"uniqueKey":"payment.oneOf.0.breakdown.upfrontCharges","typeLabel":"string"},"walletCharge":{"type":"string","description":"Wallet charge amount in decimal dollar format.","isRequired":true,"uniqueKey":"payment.oneOf.0.breakdown.walletCharge","typeLabel":"string"}},"required":["upfrontCharges","walletCharge"],"isRequired":true,"uniqueKey":"payment.oneOf.0.breakdown","typeLabel":"object"},"checkoutUrl":{"type":"string","description":"Checkout page URL for customer payment completion.","isRequired":true,"uniqueKey":"payment.oneOf.0.checkoutUrl","typeLabel":"string"},"paymentSessionId":{"type":"string","description":"Payment session identifier for upfront payment processing.","isRequired":true,"uniqueKey":"payment.oneOf.0.paymentSessionId","typeLabel":"string"},"status":{"type":"string","description":"Payment status","enum":["pending"],"isRequired":true,"uniqueKey":"payment.oneOf.0.status","typeLabel":"enum\u003cstring>"},"invoiceId":{"type":"string","description":"ID of the invoice linked to this payment.","uniqueKey":"payment.oneOf.0.invoiceId","typeLabel":"string"}},"uniqueKey":"payment.oneOf.0","typeLabel":"object"},{"type":"object","description":"Payment session details when upfront payment is required, or confirmation of a zero-amount paid invoice","required":["invoiceId","amount","status"],"properties":{"invoiceId":{"type":"string","description":"The Invoice 0 id","isRequired":true,"uniqueKey":"payment.oneOf.1.invoiceId","typeLabel":"string"},"amount":{"type":"string","description":"Payment amount ('0' for zero-amount subscriptions)","isRequired":true,"uniqueKey":"payment.oneOf.1.amount","typeLabel":"string"},"status":{"type":"string","description":"Payment status","enum":["paid"],"isRequired":true,"uniqueKey":"payment.oneOf.1.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"payment.oneOf.1","typeLabel":"object"},{"type":"object","description":"Payment session details when upfront payment is required, or confirmation of a zero-amount paid invoice","required":["invoiceId","amount","status"],"properties":{"invoiceId":{"type":"string","description":"The Invoice 0 id awaiting approval","isRequired":true,"uniqueKey":"payment.oneOf.2.invoiceId","typeLabel":"string"},"amount":{"type":"string","description":"Total payment amount in decimal dollar format","isRequired":true,"uniqueKey":"payment.oneOf.2.amount","typeLabel":"string"},"status":{"type":"string","description":"Payment status","enum":["awaiting_approval"],"isRequired":true,"uniqueKey":"payment.oneOf.2.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"payment.oneOf.2","typeLabel":"object"}],"uniqueKey":"payment","typeLabel":"object"},"planVersionId":{"type":"string","description":"The plan version pinned to this subscription at creation.","uniqueKey":"planVersionId","typeLabel":"string"},"versionNumber":{"type":"integer","minimum":1,"description":"The version number of the plan version referenced by planVersionId, as of subscription creation.","uniqueKey":"versionNumber","typeLabel":"integer"},"prefundAmount":{"type":"string","deprecated":true,"description":"Deprecated. Legacy-only, not populated for new subscriptions.","uniqueKey":"prefundAmount","typeLabel":"string"},"minimumAccountBalance":{"type":"string","deprecated":true,"description":"Deprecated. Legacy-only, not populated for new subscriptions.","uniqueKey":"minimumAccountBalance","typeLabel":"string"},"terminatedAt":{"type":"string","format":"date-time","uniqueKey":"terminatedAt","typeLabel":"string\u003cdate-time>"},"terminatedBy":{"type":"string","description":"ID of who terminated the subscription (customer ID or merchant ID)","uniqueKey":"terminatedBy","typeLabel":"string"},"terminationReason":{"type":"string","description":"Reason for termination","uniqueKey":"terminationReason","typeLabel":"string"},"terminationChangeReason":{"oneOf":[{"type":"string","enum":["commercial","correction","migration","unspecified","contractual",null],"x-speakeasy-unknown-values":"allow","description":"Why the subscription was terminated. Null while it is not terminated.","uniqueKey":"terminationChangeReason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["commercial","correction","migration","unspecified","contractual",null],"x-speakeasy-unknown-values":"allow","description":"Why the subscription was terminated. Null while it is not terminated.","uniqueKey":"terminationChangeReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"terminationChangeReason","typeLabel":"enum\u003cstring> | null"},"testClockId":{"type":"string","description":"Test clock ID if this subscription is attached to a test clock. Only present in non-production environments.","uniqueKey":"testClockId","typeLabel":"string"},"walletId":{"type":"string","deprecated":true,"description":"Deprecated. Legacy-only, not populated for new subscriptions.","uniqueKey":"walletId","typeLabel":"string"},"renewalReminderEnabled":{"oneOf":[{"type":"boolean","description":"Whether renewal reminder emails are enabled for this subscription. Null means use plan default.","uniqueKey":"renewalReminderEnabled.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether renewal reminder emails are enabled for this subscription. Null means use plan default.","uniqueKey":"renewalReminderEnabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"renewalReminderEnabled","typeLabel":"boolean | null"},"renewalReminderDays":{"oneOf":[{"type":"integer","description":"Number of days before renewal to send the reminder. Null means use plan default.","uniqueKey":"renewalReminderDays.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Number of days before renewal to send the reminder. Null means use plan default.","uniqueKey":"renewalReminderDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"renewalReminderDays","typeLabel":"integer | null"},"autoApprove":{"oneOf":[{"type":"boolean","description":"Subscription-level auto-approval override. Null means plan default is used.","uniqueKey":"autoApprove.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Subscription-level auto-approval override. Null means plan default is used.","uniqueKey":"autoApprove.oneOf.1","typeLabel":"null"}],"uniqueKey":"autoApprove","typeLabel":"boolean | null"},"metadata":{"type":"object","description":"Free-form merchant metadata to attach to the subscription. Values must be strings, numbers, or booleans.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"metadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"metadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"metadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"metadata","typeLabel":"object"},"customer":{"type":"object","description":"Customer details with merchant and consumer information. Only included when include=customer is specified in the list query.","properties":{"id":{"type":"string","description":"Customer ID","uniqueKey":"customer.id","typeLabel":"string"},"merchantId":{"type":"string","description":"Merchant organization ID","uniqueKey":"customer.merchantId","typeLabel":"string"},"merchant":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"customer.merchant.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"customer.merchant.name","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"customer.merchant.email","typeLabel":"string"}},"required":["id","name","email"],"uniqueKey":"customer.merchant","typeLabel":"object"},"consumer":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"customer.consumer.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"customer.consumer.name","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"customer.consumer.email","typeLabel":"string"}},"required":["id","name","email"],"uniqueKey":"customer.consumer","typeLabel":"object"}},"uniqueKey":"customer","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"sub_a1b2c3d4e5f6g7h8","object":"subscription","versionPolicy":"floating","autoCharge":false,"taxExempt":false,"createdAt":"2024-01-15T10:30:00Z","customerId":"cus_i9j0k1l2m3n4o5p6","endingAt":null,"estimatedTaxRate":8.5,"name":"TechCorp - LLM API Access","payment":{"amount":"250.00","breakdown":{"upfrontCharges":"50.00","walletCharge":"200.00"},"checkoutUrl":"https://checkout.paygentic.com/session/ps_b3c4d5e6f7g8h9i0","paymentSessionId":"ps_b3c4d5e6f7g8h9i0"},"planId":"plan_q7r8s9t0u1v2w3x4","startedAt":"2024-01-15T10:30:00Z","elapsedPeriodBilling":"none","billingStartsAt":"2024-01-15T10:30:00Z","billingAnchor":"2024-01-15T10:00:00Z","billingCadence":"P1M","status":"active","terminatedAt":null,"terminatedBy":null,"terminationReason":null,"updatedAt":"2024-01-15T10:30:00Z"},"examples":{"Example":{"title":"Example","value":{"id":"sub_a1b2c3d4e5f6g7h8","object":"subscription","versionPolicy":"floating","autoCharge":false,"taxExempt":false,"createdAt":"2024-01-15T10:30:00Z","customerId":"cus_i9j0k1l2m3n4o5p6","endingAt":null,"estimatedTaxRate":8.5,"name":"TechCorp - LLM API Access","payment":{"amount":"250.00","breakdown":{"upfrontCharges":"50.00","walletCharge":"200.00"},"checkoutUrl":"https://checkout.paygentic.com/session/ps_b3c4d5e6f7g8h9i0","paymentSessionId":"ps_b3c4d5e6f7g8h9i0"},"planId":"plan_q7r8s9t0u1v2w3x4","startedAt":"2024-01-15T10:30:00Z","elapsedPeriodBilling":"none","billingStartsAt":"2024-01-15T10:30:00Z","billingAnchor":"2024-01-15T10:00:00Z","billingCadence":"P1M","status":"active","terminatedAt":null,"terminatedBy":null,"terminationReason":null,"updatedAt":"2024-01-15T10:30:00Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"50db8565-d359-4abf-9e61-02a134a1bccf":{"description":"Bad Request - The request could not be understood or was missing required parameters","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["message"],"example":{"message":"The requested resource was not found","error":"not_found"},"properties":{"message":{"type":"string","description":"Human-readable error message. Clients must not parse this field programmatically.","isRequired":true,"uniqueKey":"oneOf.0.message","typeLabel":"string"},"error":{"type":"string","description":"Coarse HTTP error category (e.g. 'bad_request', 'forbidden'). Maps to the HTTP status code.","uniqueKey":"oneOf.0.error","typeLabel":"string"},"code":{"type":"string","examples":["TAX_NOT_ENABLED","PAYMENT_SESSION_EXPIRED"],"description":"Optional semantic business error code for machine-readable discrimination (e.g. 'TAX_NOT_ENABLED'). UPPER_SNAKE_CASE. Clients should check this field, not message.","uniqueKey":"oneOf.0.code","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"oneOf.0.details","typeLabel":"object"},"reason":{"type":"string","enum":["no_permission","insufficient_scope","not_member"],"description":"Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.","uniqueKey":"oneOf.0.reason","typeLabel":"enum\u003cstring>"},"requiredPermissions":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.requiredPermissions.items.[INDEX]","typeLabel":"string"},"description":"Present on a 403 from the authorization check. The permissions the caller needs for this request.","uniqueKey":"oneOf.0.requiredPermissions","typeLabel":"string[]"},"requestId":{"type":"string","description":"Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.","examples":["105445aa7843bc8bf206b12000100000"],"uniqueKey":"oneOf.0.requestId","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["message","errors"],"example":{"message":"Validation failed","error":"validation_error","errors":[{"field":"email","message":"Invalid email format","code":"invalid_format"}]},"properties":{"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"oneOf.1.message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The field that failed validation","isRequired":true,"uniqueKey":"oneOf.1.errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Validation error message for this field","isRequired":true,"uniqueKey":"oneOf.1.errors.items.[INDEX].message","typeLabel":"string"},"code":{"type":"string","description":"Validation error code","uniqueKey":"oneOf.1.errors.items.[INDEX].code","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"oneOf.1.errors.items.[INDEX]","typeLabel":"object"},"description":"Array of field-specific validation errors","isRequired":true,"uniqueKey":"oneOf.1.errors","typeLabel":"object[]"},"error":{"type":"string","enum":["validation_error"],"default":"validation_error","description":"Error type indicating validation failure","uniqueKey":"oneOf.1.error","typeLabel":"enum\u003cstring>"},"requestId":{"type":"string","description":"Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.","examples":["105445aa7843bc8bf206b12000100000"],"uniqueKey":"oneOf.1.requestId","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The requested resource was not found","error":"not_found"}}},"exampleType":"generated"}},"exampleType":"generated"},"26bb10bf-df84-4d1d-bb18-2512b51c0f11":{"description":"Unauthorized - Authentication failed or user does not have permissions","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable error message. Clients must not parse this field programmatically.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Coarse HTTP error category (e.g. 'bad_request', 'forbidden'). Maps to the HTTP status code.","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","examples":["TAX_NOT_ENABLED","PAYMENT_SESSION_EXPIRED"],"description":"Optional semantic business error code for machine-readable discrimination (e.g. 'TAX_NOT_ENABLED'). UPPER_SNAKE_CASE. Clients should check this field, not message.","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"},"reason":{"type":"string","enum":["no_permission","insufficient_scope","not_member"],"description":"Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.","uniqueKey":"reason","typeLabel":"enum\u003cstring>"},"requiredPermissions":{"type":"array","items":{"type":"string","uniqueKey":"requiredPermissions.items.[INDEX]","typeLabel":"string"},"description":"Present on a 403 from the authorization check. The permissions the caller needs for this request.","uniqueKey":"requiredPermissions","typeLabel":"string[]"},"requestId":{"type":"string","description":"Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.","examples":["105445aa7843bc8bf206b12000100000"],"uniqueKey":"requestId","typeLabel":"string"}},"example":{"message":"The requested resource was not found","error":"not_found"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The requested resource was not found","error":"not_found"}}},"exampleType":"generated"}},"exampleType":"generated"},"7801fadf-7b83-4c61-b2fb-f2de0d11dfa7":{"description":"Forbidden - Request is understood but refused","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable error message. Clients must not parse this field programmatically.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Coarse HTTP error category (e.g. 'bad_request', 'forbidden'). Maps to the HTTP status code.","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","examples":["TAX_NOT_ENABLED","PAYMENT_SESSION_EXPIRED"],"description":"Optional semantic business error code for machine-readable discrimination (e.g. 'TAX_NOT_ENABLED'). UPPER_SNAKE_CASE. Clients should check this field, not message.","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"},"reason":{"type":"string","enum":["no_permission","insufficient_scope","not_member"],"description":"Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.","uniqueKey":"reason","typeLabel":"enum\u003cstring>"},"requiredPermissions":{"type":"array","items":{"type":"string","uniqueKey":"requiredPermissions.items.[INDEX]","typeLabel":"string"},"description":"Present on a 403 from the authorization check. The permissions the caller needs for this request.","uniqueKey":"requiredPermissions","typeLabel":"string[]"},"requestId":{"type":"string","description":"Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.","examples":["105445aa7843bc8bf206b12000100000"],"uniqueKey":"requestId","typeLabel":"string"}},"example":{"message":"The requested resource was not found","error":"not_found"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The requested resource was not found","error":"not_found"}}},"exampleType":"generated"}},"exampleType":"generated"},"381c0313-d617-461a-83f3-4b9a803e9e1e":{"description":"Not Found - The requested resource could not be found","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable error message. Clients must not parse this field programmatically.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Coarse HTTP error category (e.g. 'bad_request', 'forbidden'). Maps to the HTTP status code.","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","examples":["TAX_NOT_ENABLED","PAYMENT_SESSION_EXPIRED"],"description":"Optional semantic business error code for machine-readable discrimination (e.g. 'TAX_NOT_ENABLED'). UPPER_SNAKE_CASE. Clients should check this field, not message.","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"},"reason":{"type":"string","enum":["no_permission","insufficient_scope","not_member"],"description":"Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.","uniqueKey":"reason","typeLabel":"enum\u003cstring>"},"requiredPermissions":{"type":"array","items":{"type":"string","uniqueKey":"requiredPermissions.items.[INDEX]","typeLabel":"string"},"description":"Present on a 403 from the authorization check. The permissions the caller needs for this request.","uniqueKey":"requiredPermissions","typeLabel":"string[]"},"requestId":{"type":"string","description":"Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.","examples":["105445aa7843bc8bf206b12000100000"],"uniqueKey":"requestId","typeLabel":"string"}},"example":{"message":"The requested resource was not found","error":"not_found"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The requested resource was not found","error":"not_found"}}},"exampleType":"generated"}},"exampleType":"generated"},"03346b2f-8553-4f16-9a2e-ace1ba33742e":{"description":"Conflict - The request conflicts with the current state of the resource","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable error message. Clients must not parse this field programmatically.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Coarse HTTP error category (e.g. 'bad_request', 'forbidden'). Maps to the HTTP status code.","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","examples":["TAX_NOT_ENABLED","PAYMENT_SESSION_EXPIRED"],"description":"Optional semantic business error code for machine-readable discrimination (e.g. 'TAX_NOT_ENABLED'). UPPER_SNAKE_CASE. Clients should check this field, not message.","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"},"reason":{"type":"string","enum":["no_permission","insufficient_scope","not_member"],"description":"Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.","uniqueKey":"reason","typeLabel":"enum\u003cstring>"},"requiredPermissions":{"type":"array","items":{"type":"string","uniqueKey":"requiredPermissions.items.[INDEX]","typeLabel":"string"},"description":"Present on a 403 from the authorization check. The permissions the caller needs for this request.","uniqueKey":"requiredPermissions","typeLabel":"string[]"},"requestId":{"type":"string","description":"Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.","examples":["105445aa7843bc8bf206b12000100000"],"uniqueKey":"requestId","typeLabel":"string"}},"example":{"message":"The requested resource was not found","error":"not_found"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The requested resource was not found","error":"not_found"}}},"exampleType":"generated"}},"exampleType":"generated"},"80a69e8a-d6e7-4232-95e6-589d742b0473":{"description":"Internal Server Error - Something went wrong on the server side","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Human-readable error message. Clients must not parse this field programmatically.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"string","description":"Coarse HTTP error category (e.g. 'bad_request', 'forbidden'). Maps to the HTTP status code.","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","examples":["TAX_NOT_ENABLED","PAYMENT_SESSION_EXPIRED"],"description":"Optional semantic business error code for machine-readable discrimination (e.g. 'TAX_NOT_ENABLED'). UPPER_SNAKE_CASE. Clients should check this field, not message.","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","description":"Additional error details","additionalProperties":true,"uniqueKey":"details","typeLabel":"object"},"reason":{"type":"string","enum":["no_permission","insufficient_scope","not_member"],"description":"Present on a 403 from the authorization check. Says why access was refused: the caller has no role that grants the permission, the OAuth token lacks the scope, or the caller is not a member of the organization.","uniqueKey":"reason","typeLabel":"enum\u003cstring>"},"requiredPermissions":{"type":"array","items":{"type":"string","uniqueKey":"requiredPermissions.items.[INDEX]","typeLabel":"string"},"description":"Present on a 403 from the authorization check. The permissions the caller needs for this request.","uniqueKey":"requiredPermissions","typeLabel":"string[]"},"requestId":{"type":"string","description":"Identifies this request in our logs. Include it when you contact support. Also sent in the `request-id` response header.","examples":["105445aa7843bc8bf206b12000100000"],"uniqueKey":"requestId","typeLabel":"string"}},"example":{"message":"The requested resource was not found","error":"not_found"},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"The requested resource was not found","error":"not_found"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"341ede1c-db03-4e32-b951-0c478552f430":{"BearerAuth":{"type":"http","scheme":"bearer","description":"API key authentication","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"7498f67e-c06f-4d11-9a4e-7c43f0f53b26":{"url":"https://api.paygentic.io","description":"Production API"},"d0f74462-aeec-4209-82f4-dbb60498c1a2":{"url":"https://api.sandbox.paygentic.io","description":"Sandbox API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key authentication","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key authentication","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"paygentic","siteName":"Paygentic","title":"Create - Paygentic","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-22T01:05:02.061Z","originalFileLocation":"api-reference/subscriptions/create.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Creates a subscription for an existing customer or creates a new customer as part of the action.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Paygentic\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create - Paygentic\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a subscription for an existing customer or creates a new customer as part of the action.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Paygentic\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.paygentic.io/api-reference/subscriptions/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paygentic.mintlify.site/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Create\u0026amp;description=Creates+a+subscription+for+an+existing+customer+or+creates+a+new+customer+as+part+of+the+action.\u0026amp;theme=6ad1713123e6dfef0529ce98\u0026amp;signature=c4626371c93e3e163877212909749b9c321f8ab6d4f2c987ab3f3884682a36b4\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create - Paygentic\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a subscription for an existing customer or creates a new customer as part of the action.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paygentic.mintlify.site/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Create\u0026amp;description=Creates+a+subscription+for+an+existing+customer+or+creates+a+new+customer+as+part+of+the+action.\u0026amp;theme=6ad1713123e6dfef0529ce98\u0026amp;signature=c4626371c93e3e163877212909749b9c321f8ab6d4f2c987ab3f3884682a36b4\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/paygentic/u-_iNQrPo4YcRgQd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Paygentic\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#013F70\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.paygentic.io/api-reference/subscriptions/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/subscriptions/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.paygentic.io/#organization\",\"name\":\"Paygentic\",\"url\":\"https://docs.paygentic.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/paygentic/uUKYt4gDqyfhF9Y7/logo/paygentic-logo-light.svg?fit=max\u0026auto=format\u0026n=uUKYt4gDqyfhF9Y7\u0026q=85\u0026s=cb1fd6b59a3c44e357ecdc522849ab37\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.paygentic.io#website\",\"name\":\"Paygentic\",\"url\":\"https://docs.paygentic.io\",\"publisher\":{\"@id\":\"https://docs.paygentic.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.paygentic.io/api-reference/subscriptions/create#webpage\",\"url\":\"https://docs.paygentic.io/api-reference/subscriptions/create\",\"name\":\"Create\",\"description\":\"Creates a subscription for an existing customer or creates a new customer as part of the action.\",\"dateModified\":\"2026-11-22T01:05:02.061Z\",\"isPartOf\":{\"@id\":\"https://docs.paygentic.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paygentic.io/api-reference/subscriptions/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paygentic.io/api-reference/subscriptions/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Subscriptions\",\"item\":\"https://docs.paygentic.io/api-reference/subscriptions/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create\",\"item\":\"https://docs.paygentic.io/api-reference/subscriptions/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.paygentic.io/api-reference/subscriptions/create#apireference\",\"headline\":\"Create\",\"name\":\"Create\",\"description\":\"Creates a subscription for an existing customer or creates a new customer as part of the action.\",\"url\":\"https://docs.paygentic.io/api-reference/subscriptions/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paygentic.io/api-reference/subscriptions/create#webpage\"},\"dateModified\":\"2026-11-22T01:05:02.061Z\",\"publisher\":{\"@id\":\"https://docs.paygentic.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.paygentic.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Paygentic\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Paygentic\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/subscriptions/create.md","siteName":"Paygentic","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/getting-started/introduction"}]},{"tab":"API Reference","groups":[{"group":"Me","pages":[{"title":"Get the caller","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/me","href":"/api-reference/me/get-the-caller"}]},{"group":"Billable Metrics","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billableMetrics","href":"/api-reference/billable-metrics/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/billableMetrics","href":"/api-reference/billable-metrics/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billableMetrics/{id}","href":"/api-reference/billable-metrics/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/billableMetrics/{id}","href":"/api-reference/billable-metrics/update"},{"title":"Query Meter Usage","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billableMetrics/{id}/meter","href":"/api-reference/billable-metrics/query-meter-usage"},{"title":"List Meter Events","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billableMetrics/{id}/events","href":"/api-reference/billable-metrics/list-meter-events"}]},{"group":"Customers","pages":[{"title":"List by Merchant","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/customers","href":"/api-reference/customers/list-by-merchant"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/customers","href":"/api-reference/customers/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/customers/{id}","href":"/api-reference/customers/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/customers/{id}","href":"/api-reference/customers/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/customers/{id}","href":"/api-reference/customers/update"},{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/customers/{id}/paymentMethods","href":"/api-reference/customers/list-payment-methods"},{"title":"Set up a payment method","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/customers/{id}/paymentMethods","href":"/api-reference/customers/set-up-a-payment-method"}]},{"group":"Entitlements","pages":[{"title":"List Entitlements","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/entitlements","href":"/api-reference/entitlements/list-entitlements"},{"title":"Issue Entitlement","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/entitlements","href":"/api-reference/entitlements/issue-entitlement"},{"title":"Get Entitlement","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/entitlements/{entitlementId}","href":"/api-reference/entitlements/get-entitlement"}]},{"group":"Grants","pages":[{"title":"List Grants","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/entitlements/{entitlementId}/grants","href":"/api-reference/grants/list-grants"},{"title":"Create Grant","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/entitlements/{entitlementId}/grants","href":"/api-reference/grants/create-grant"},{"title":"Purchase Grant","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/entitlements/{entitlementId}/grants/purchase","href":"/api-reference/grants/purchase-grant"},{"title":"Get Grant","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/entitlements/{entitlementId}/grants/{grantId}","href":"/api-reference/grants/get-grant"},{"title":"Void Grant","deprecated":null,"version":null,"openapi":"/openapi.json delete /v1/entitlements/{entitlementId}/grants/{grantId}","href":"/api-reference/grants/void-grant"}]},{"group":"Features","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/features","href":"/api-reference/features/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/features","href":"/api-reference/features/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/features/{id}","href":"/api-reference/features/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/features/{id}","href":"/api-reference/features/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/features/{id}","href":"/api-reference/features/update"}]},{"group":"Fees","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/fees","href":"/api-reference/fees/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/fees","href":"/api-reference/fees/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/fees/{id}","href":"/api-reference/fees/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/fees/{id}","href":"/api-reference/fees/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/fees/{id}","href":"/api-reference/fees/update"}]},{"group":"Plans","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/plans","href":"/api-reference/plans/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/plans","href":"/api-reference/plans/create"},{"title":"List Available Plans","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/plans/available","href":"/api-reference/plans/list-available-plans"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/plans/{id}","href":"/api-reference/plans/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/plans/{id}","href":"/api-reference/plans/update"},{"title":"List versions","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/plans/{id}/versions","href":"/api-reference/plans/list-versions"},{"title":"Mint a plan version","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/plans/{id}/versions","href":"/api-reference/plans/mint-a-plan-version"},{"title":"Get a version","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/plans/{id}/versions/{versionNumber}","href":"/api-reference/plans/get-a-version"},{"title":"Set the default version","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/plans/{id}/versions/{versionNumber}","href":"/api-reference/plans/set-the-default-version"}]},{"group":"Prices","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/prices","href":"/api-reference/prices/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/prices","href":"/api-reference/prices/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/prices/{id}","href":"/api-reference/prices/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/prices/{id}","href":"/api-reference/prices/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/prices/{id}","href":"/api-reference/prices/update"}]},{"group":"Products","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/products","href":"/api-reference/products/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/products","href":"/api-reference/products/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/products/{id}","href":"/api-reference/products/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/products/{id}","href":"/api-reference/products/update"}]},{"group":"Sources","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/sources","href":"/api-reference/sources/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/sources","href":"/api-reference/sources/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/sources/{id}","href":"/api-reference/sources/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/sources/{id}","href":"/api-reference/sources/update"},{"title":"List Events","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/sources/{id}/events","href":"/api-reference/sources/list-events"},{"title":"Approve","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/sources/{id}/events/{eventId}/approve","href":"/api-reference/sources/approve"},{"title":"Reject","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/sources/{id}/events/{eventId}/reject","href":"/api-reference/sources/reject"},{"title":"Bulk Approve","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/sources/{id}/events/bulk-approve","href":"/api-reference/sources/bulk-approve"},{"title":"Bulk Reject","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/sources/{id}/events/bulk-reject","href":"/api-reference/sources/bulk-reject"},{"title":"List Rules","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/sourceRules","href":"/api-reference/sources/list-rules"},{"title":"Create Rule","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/sourceRules","href":"/api-reference/sources/create-rule"},{"title":"Get Rule","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/sourceRules/{ruleId}","href":"/api-reference/sources/get-rule"},{"title":"Delete Rule","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/sourceRules/{ruleId}","href":"/api-reference/sources/delete-rule"},{"title":"Update Rule","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/sourceRules/{ruleId}","href":"/api-reference/sources/update-rule"}]},{"group":"Subscriptions","pages":[{"title":"List","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptions","href":"/api-reference/subscriptions/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions","href":"/api-reference/subscriptions/create"},{"title":"Get","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptions/{id}","href":"/api-reference/subscriptions/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/subscriptions/{id}","href":"/api-reference/subscriptions/update"},{"title":"Get Price Intervals","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptions/{id}/intervals","href":"/api-reference/subscriptions/get-price-intervals"},{"title":"Edit Price Intervals","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions/{id}/intervals","href":"/api-reference/subscriptions/edit-price-intervals"},{"title":"Migrate To A Plan Version","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions/{id}/versionMigration","href":"/api-reference/subscriptions/migrate-to-a-plan-version"},{"title":"List Interval Changes","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptions/{id}/intervalChanges","href":"/api-reference/subscriptions/list-interval-changes"},{"title":"List Merchant Interval Changes","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/intervalChanges","href":"/api-reference/subscriptions/list-merchant-interval-changes"},{"title":"Generate Portal Link","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions/{id}/portal","href":"/api-reference/subscriptions/generate-portal-link"},{"title":"Terminate","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions/{id}/termination","href":"/api-reference/subscriptions/terminate"},{"title":"Reconcile Features","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions/{id}/reconciliations","href":"/api-reference/subscriptions/reconcile-features"},{"title":"List Adjustments","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptions/{id}/adjustments","href":"/api-reference/subscriptions/list-adjustments"},{"title":"Create Adjustment","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptions/{id}/adjustments","href":"/api-reference/subscriptions/create-adjustment"},{"title":"Delete Adjustment","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/subscriptions/{id}/adjustments/{adjustmentId}","href":"/api-reference/subscriptions/delete-adjustment"}]},{"group":"Subscription Proposals","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptionProposals","href":"/api-reference/subscription-proposals/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptionProposals","href":"/api-reference/subscription-proposals/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptionProposals/{id}","href":"/api-reference/subscription-proposals/get"},{"title":"Amend","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/subscriptionProposals/{id}","href":"/api-reference/subscription-proposals/amend"},{"title":"Approve or reject","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptionProposals/{id}/decision","href":"/api-reference/subscription-proposals/approve-or-reject"},{"title":"List projected","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/subscriptionProposals/{id}/projected","href":"/api-reference/subscription-proposals/list-projected"}]},{"group":"Users","pages":[{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/users/{id}","href":"/api-reference/users/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/users/{id}","href":"/api-reference/users/update"}]},{"group":"Invoices V2","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices","href":"/api-reference/invoices-v2/list"},{"title":"List Line Items","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices/lineItems","href":"/api-reference/invoices-v2/list-line-items"},{"title":"Create Manual Line Item","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/invoices/lineItems","href":"/api-reference/invoices-v2/create-manual-line-item"},{"title":"List projected","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices/projected","href":"/api-reference/invoices-v2/list-projected"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices/{id}","href":"/api-reference/invoices-v2/get"},{"title":"Get Line Items","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices/{id}/lineItems","href":"/api-reference/invoices-v2/get-line-items"},{"title":"Download Invoice PDF","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices/{id}/pdf","href":"/api-reference/invoices-v2/download-invoice-pdf"},{"title":"Settle Invoice Payment","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/invoices/{id}/payment","href":"/api-reference/invoices-v2/settle-invoice-payment"},{"title":"List Invoice Refunds","deprecated":null,"version":null,"openapi":"/openapi.json get /v2/invoices/{id}/refunds","href":"/api-reference/invoices-v2/list-invoice-refunds"},{"title":"Refund Invoice","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/invoices/{id}/refunds","href":"/api-reference/invoices-v2/refund-invoice"},{"title":"Void Invoice Refund","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/invoices/{id}/refunds/{refundId}/void","href":"/api-reference/invoices-v2/void-invoice-refund"},{"title":"Retry Payment","deprecated":null,"version":null,"openapi":"/openapi.json post /v2/invoices/{id}/retryPayment","href":"/api-reference/invoices-v2/retry-payment"}]},{"group":"Payments","pages":[{"title":"List Payments","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/payments","href":"/api-reference/payments/list-payments"},{"title":"Create Payment","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/payments","href":"/api-reference/payments/create-payment"},{"title":"Get Payment","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/payments/{id}","href":"/api-reference/payments/get-payment"}]},{"group":"Payment Sessions","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/paymentSessions","href":"/api-reference/payment-sessions/list"}]},{"group":"Events","pages":[{"title":"Ingest Event","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/events","href":"/api-reference/events/ingest-event"}]},{"group":"Costs","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/costs","href":"/api-reference/costs/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/costs","href":"/api-reference/costs/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/costs/{id}","href":"/api-reference/costs/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/costs/{id}","href":"/api-reference/costs/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/costs/{id}","href":"/api-reference/costs/update"},{"title":"Query Summary","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/costs/{id}/summary","href":"/api-reference/costs/query-summary"},{"title":"Report","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/costs/report","href":"/api-reference/costs/report"}]},{"group":"Revenue","pages":[{"title":"Get revenue summary","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/revenue","href":"/api-reference/revenue/get-revenue-summary"},{"title":"List customer accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/revenue/accounts","href":"/api-reference/revenue/list-customer-accounts"}]},{"group":"Profitability","pages":[{"title":"Get profitability summary","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/profitability","href":"/api-reference/profitability/get-profitability-summary"}]},{"group":"Test Clocks","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/testClocks","href":"/api-reference/test-clocks/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/testClocks","href":"/api-reference/test-clocks/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/testClocks/{id}","href":"/api-reference/test-clocks/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/testClocks/{id}","href":"/api-reference/test-clocks/delete"},{"title":"Advance","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/testClocks/{id}","href":"/api-reference/test-clocks/advance"}]},{"group":"Merchant Data","pages":[{"title":"Reset a merchant's data","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/merchants/{merchantId}/reset","href":"/api-reference/merchant-data/reset-a-merchants-data"}]},{"group":"ExternalReferences","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/externalReferences","href":"/api-reference/externalreferences/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/externalReferences","href":"/api-reference/externalreferences/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/externalReferences/{id}","href":"/api-reference/externalreferences/get"},{"title":"Delete","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/externalReferences/{id}","href":"/api-reference/externalreferences/delete"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/externalReferences/{id}","href":"/api-reference/externalreferences/update"}]},{"group":"Items","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/items","href":"/api-reference/items/list"},{"title":"Create","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/items","href":"/api-reference/items/create"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/items/{id}","href":"/api-reference/items/get"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/items/{id}","href":"/api-reference/items/update"}]},{"group":"Orders","pages":[{"title":"List orders","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/orders","href":"/api-reference/orders/list-orders"},{"title":"Create an order","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/orders","href":"/api-reference/orders/create-an-order"},{"title":"Get an order","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/orders/{id}","href":"/api-reference/orders/get-an-order"},{"title":"Delete an order","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/orders/{id}","href":"/api-reference/orders/delete-an-order"},{"title":"Update an order","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/orders/{id}","href":"/api-reference/orders/update-an-order"},{"title":"Add a line item","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/orders/{orderId}/lineItems","href":"/api-reference/orders/add-a-line-item"},{"title":"Delete a line item","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/orders/{orderId}/lineItems/{id}","href":"/api-reference/orders/delete-a-line-item"},{"title":"Update a line item","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/orders/{orderId}/lineItems/{id}","href":"/api-reference/orders/update-a-line-item"},{"title":"Create an approval for the order","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/orders/{orderId}/approvals","href":"/api-reference/orders/create-an-approval-for-the-order"}]},{"group":"Billing Schedules","pages":[{"title":"List billing schedules","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billingSchedules","href":"/api-reference/billing-schedules/list-billing-schedules"},{"title":"Create a billing schedule","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/billingSchedules","href":"/api-reference/billing-schedules/create-a-billing-schedule"},{"title":"Get a billing schedule","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billingSchedules/{id}","href":"/api-reference/billing-schedules/get-a-billing-schedule"},{"title":"Delete a billing schedule","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/billingSchedules/{id}","href":"/api-reference/billing-schedules/delete-a-billing-schedule"},{"title":"Update a billing schedule","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/billingSchedules/{id}","href":"/api-reference/billing-schedules/update-a-billing-schedule"},{"title":"List schedule intervals","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billingSchedules/{id}/intervals","href":"/api-reference/billing-schedules/list-schedule-intervals"},{"title":"Replace schedule intervals","deprecated":null,"version":null,"openapi":"/openapi.json put /v0/billingSchedules/{id}/intervals","href":"/api-reference/billing-schedules/replace-schedule-intervals"},{"title":"List staged invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/billingSchedules/{id}/invoices","href":"/api-reference/billing-schedules/list-staged-invoices"},{"title":"Generate staged invoices","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/billingSchedules/{id}/invoices","href":"/api-reference/billing-schedules/generate-staged-invoices"}]},{"group":"Salesforce","pages":[{"title":"List Salesforce accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/integrations/salesforce/accounts","href":"/api-reference/salesforce/list-salesforce-accounts"}]},{"group":"MerchantIntegrations","pages":[{"title":"List","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/merchantIntegrations","href":"/api-reference/merchantintegrations/list"},{"title":"Upsert","deprecated":null,"version":null,"openapi":"/openapi.json put /v0/merchantIntegrations","href":"/api-reference/merchantintegrations/upsert"},{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/merchantIntegrations/{id}","href":"/api-reference/merchantintegrations/get"},{"title":"Disconnect","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/merchantIntegrations/{id}/disconnect","href":"/api-reference/merchantintegrations/disconnect"}]},{"group":"Approvals","pages":[{"title":"List approvals","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/approvals","href":"/api-reference/approvals/list-approvals"},{"title":"Submit a resource for approval","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/approvals","href":"/api-reference/approvals/submit-a-resource-for-approval"},{"title":"Get an approval","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/approvals/{id}","href":"/api-reference/approvals/get-an-approval"},{"title":"Update an approval (approve, reject, or cancel)","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/approvals/{id}","href":"/api-reference/approvals/update-an-approval-approve-reject-or-cancel"}]},{"group":"Webhooks","pages":[{"title":"Get","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/webhooks","href":"/api-reference/webhooks/get"},{"title":"Enable","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/webhooks","href":"/api-reference/webhooks/enable"},{"title":"Disable","deprecated":null,"version":null,"openapi":"/openapi.json delete /v0/webhooks","href":"/api-reference/webhooks/disable"},{"title":"Update","deprecated":null,"version":null,"openapi":"/openapi.json patch /v0/webhooks","href":"/api-reference/webhooks/update"},{"title":"Get Portal Access","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/webhooks/portal","href":"/api-reference/webhooks/get-portal-access"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Create - Paygentic","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}