{
"message": "The requested resource was not found",
"error": "not_found"
}
{
"message": "The requested resource was not found",
"error": "not_found"
}
Subscription Proposals
Create
Creates a pending subscription proposal from the values of a subscription create. The customer must already exist. A plan or customer of another merchant answers 404, as an unknown one does. The values are checked as subscription create checks them, at the moment of the request, but no subscription, invoice or entitlement exists until a person approves the proposal.
With an externalReference, the create first finds the proposal that record already has: its pending or approved proposal, else its most recent rejected one. Sends of one record are handled one at a time. Values are compared after normalization: key order does not count, a field sent with its default equals the field left out, and two forms of one instant, such as Z and +00:00, are equal.
None found: a new proposal, 201.
Values equal to that proposal’s requested: the proposal, 200. Nothing is checked. A stored refusedResync is cleared, which raises lockVersion and changes hash; without one, nothing is written.
A pending proposal, values changed: the values become the next revision and requested. current takes each changed field except a field in amendedFields, which keeps the person’s value, and a field left out returns to its default. The result is checked as an amend is, and answered 200.
A pending proposal whose change conflicts with an amendment: 409 SUBSCRIPTION_PROPOSAL_RESYNC_CONFLICT, and current and requested do not change. details.fields names each conflicting field. A field conflicts when the client changed it, a person amended it, and the new value differs from current. Leaving out a field the previous send set changes it to its default, so leaving out an amended field conflicts too. A change also conflicts when it would leave price fields (planVersionId, overridePrices, addPrices, removePrices, adjustments) naming another plan’s prices, and when it would change versionPolicy while planVersionId is amended.
An approved proposal, values changed: 409 SUBSCRIPTION_PROPOSAL_ALREADY_APPROVED, with the subscription’s id in details.subscriptionId. Changes to an active subscription are not supported yet.
A rejected proposal, values changed: a new proposal, 201. The rejected one is unchanged.
A refused send is kept on the proposal as refusedResync, so a reviewer sees it. A send that repeats the stored refusal changes nothing.
{
"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
customerId
string
required
Unique identifier for a customer
Pattern: ^cus_[a-zA-Z0-9]+$
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.
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
CreateSubscriptionProposalRedirectUrls · 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"). A non-zero value needs metadata.bankTransferOnly: true; without it the request answers 400 PAYMENT_TERM_DAYS_REQUIRES_BANK_TRANSFER_ONLY.
Required range: 0 <= x <= 365
sessionExpiryMinutes
number
Number of minutes until the payment session expires. Defaults to 240 minutes (4 hours) if not provided.
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
planVersionId
string
A published version of planId to pin the proposal to. Only a pinned proposal (versionPolicy: "pinned") names a version. One that names none, or null, pins the plan's default version, as a change of planId without a version does. A floating proposal follows the plan's default version, and one that names a version is refused with 400.
adjustments
object[]
Adjustments the subscription gets when the proposal is approved. Each is checked as subscription adjustment create checks it, against the prices the proposal bills and the other adjustments in this list.
Maximum array length: 25
One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.
Option 1
Option 2
Option 3
Option 4
Show child attributes
externalReference
object
The record in another system, such as a CRM deal, that the proposal comes from. A create naming a record that already has a proposal acts on that proposal, as the create operation describes.
Show child attributes
Response
The proposal the external reference already has, unchanged or re-synced
A subscription a client proposed, held until a person approves or rejects it. No subscription exists until it is approved.
id
string
required
object
enum<string>
required
Available options:
subscriptionProposal
merchantId
string
required
Unique identifier for an organization
Pattern: ^org_[a-zA-Z0-9]+$
status
enum<string>
required
pending until a person approves or rejects the proposal.
Available options:
pending,
approved,
rejected
customerId
string
required
Unique identifier for a customer
Pattern: ^cus_[a-zA-Z0-9]+$
planId
string
required
Unique identifier for a plan
Pattern: ^plan_[a-zA-Z0-9]+$
planVersionId
string | null
required
The plan version a pinned proposal is pinned to. Null for a floating proposal, which follows the plan's default version.
resolvedPlanVersionId
string | null
required
The plan version approve would use now: planVersionId when pinned, else the plan's default version. Null when the plan has no published version.
hash
string
required
Changes whenever current or resolvedPlanVersionId changes. A decision sends it as basedOnHash, so a person only decides on the proposal they read.
testClockId
string | null
required
requested
object
required
The values as the client last sent them, without externalReference.
Show child attributes
current
object
required
The values as they are now, amendments included, with planVersionId when the proposal is pinned. Approve creates the subscription from them.
Show child attributes
amendedFields
string[]
required
The top-level fields a person amended. A re-send of the external reference keeps the person's value for each; a field stays amended when the client sends the person's value.
refusedResync
object | null
required
The CRM's latest refused re-sync, or null. It changes hash, so a decision made before it arrived answers 409 SUBSCRIPTION_PROPOSAL_CHANGED.
Show child attributes
lockVersion
integer
required
Starts at 1, and every change to the proposal adds one.
source
string
required
The provider of the proposal's external reference, or api when it has none.
externalReference
object | null
required
The record the proposal comes from. Null when it was created without one.
Show child attributes
subscriptionId
string | null
required
The subscription approve created.
rejectionReason
enum<string> | null
required
Why the proposal was rejected. Null unless it is rejected.
Available options:
price_mismatch,
wrong_plan,
wrong_start_date,
wrong_customer,
duplicate,
other
rejectionText
string | null
required
The notes the reviewer gave with the rejection.
decidedAt
string<date-time> | null
required
decidedByPrincipalId
string | null
required
decidedBy
object | null
required
Who approved or rejected the proposal, by name. Null until it is decided, and when the decider cannot be named: a decision made with the platform key, or by a principal that no longer exists.
Show child attributes
strandedAt
string<date-time> | null
required
Set when an approve ended with its subscription waiting for its first invoice; a repeated approve resumes it.
createdByPrincipalId
string | null
required
createdByCredentialId
string | null
required
The API key or OAuth client that created the proposal; null for a dashboard session.
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
revisions
object[]
Each set of values the client sent, earliest first. Present only with expand=revisions. The last one is requested.
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":"6afd5b9459e0aa06398df0fc","clientVersion":"0.0.4205","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":"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":"control","enabled":true,"payload":{"type":"string","value":"control"},"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/subscription-proposals/create","slug":"/api-reference/subscription-proposals/create","pageMetadata":{"title":"Create","description":"Creates a pending subscription proposal from the values of a subscription create. The customer must already exist. A plan or customer of another merchant answers 404, as an unknown one does. The values are checked as subscription create checks them, at the moment of the request, but no subscription, invoice or entitlement exists until a person approves the proposal.\n\nWith an `externalReference`, the create first finds the proposal that record already has: its pending or approved proposal, else its most recent rejected one. Sends of one record are handled one at a time. Values are compared after normalization: key order does not count, a field sent with its default equals the field left out, and two forms of one instant, such as `Z` and `+00:00`, are equal.\n\n- None found: a new proposal, 201.\n- Values equal to that proposal's `requested`: the proposal, 200. Nothing is checked. A stored `refusedResync` is cleared, which raises `lockVersion` and changes `hash`; without one, nothing is written.\n- A pending proposal, values changed: the values become the next revision and `requested`. `current` takes each changed field except a field in `amendedFields`, which keeps the person's value, and a field left out returns to its default. The result is checked as an amend is, and answered 200.\n- A pending proposal whose change conflicts with an amendment: 409 `SUBSCRIPTION_PROPOSAL_RESYNC_CONFLICT`, and `current` and `requested` do not change. `details.fields` names each conflicting field. A field conflicts when the client changed it, a person amended it, and the new value differs from `current`. Leaving out a field the previous send set changes it to its default, so leaving out an amended field conflicts too. A change also conflicts when it would leave price fields (`planVersionId`, `overridePrices`, `addPrices`, `removePrices`, `adjustments`) naming another plan's prices, and when it would change `versionPolicy` while `planVersionId` is amended.\n- An approved proposal, values changed: 409 `SUBSCRIPTION_PROPOSAL_ALREADY_APPROVED`, with the subscription's id in `details.subscriptionId`. Changes to an active subscription are not supported yet.\n- A rejected proposal, values changed: a new proposal, 201. The rejected one is unchanged.\n\nA refused send is kept on the proposal as `refusedResync`, so a reviewer sees it. A send that repeats the stored refusal changes nothing.","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptionProposals","href":"/api-reference/subscription-proposals/create","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Creates a pending subscription proposal from the values of a subscription create. The customer must already exist. A plan or customer of another merchant answers 404, as an unknown one does. The values are checked as subscription create checks them, at the moment of the request, but no subscription, invoice or entitlement exists until a person approves the proposal.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"With an \", _jsx(_components.code, {\n children: \"externalReference\"\n }), \", the create first finds the proposal that record already has: its pending or approved proposal, else its most recent rejected one. Sends of one record are handled one at a time. Values are compared after normalization: key order does not count, a field sent with its default equals the field left out, and two forms of one instant, such as \", _jsx(_components.code, {\n children: \"Z\"\n }), \" and \", _jsx(_components.code, {\n children: \"+00:00\"\n }), \", are equal.\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"None found: a new proposal, 201.\"\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Values equal to that proposal’s \", _jsx(_components.code, {\n children: \"requested\"\n }), \": the proposal, 200. Nothing is checked. A stored \", _jsx(_components.code, {\n children: \"refusedResync\"\n }), \" is cleared, which raises \", _jsx(_components.code, {\n children: \"lockVersion\"\n }), \" and changes \", _jsx(_components.code, {\n children: \"hash\"\n }), \"; without one, nothing is written.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"A pending proposal, values changed: the values become the next revision and \", _jsx(_components.code, {\n children: \"requested\"\n }), \". \", _jsx(_components.code, {\n children: \"current\"\n }), \" takes each changed field except a field in \", _jsx(_components.code, {\n children: \"amendedFields\"\n }), \", which keeps the person’s value, and a field left out returns to its default. The result is checked as an amend is, and answered 200.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"A pending proposal whose change conflicts with an amendment: 409 \", _jsx(_components.code, {\n children: \"SUBSCRIPTION_PROPOSAL_RESYNC_CONFLICT\"\n }), \", and \", _jsx(_components.code, {\n children: \"current\"\n }), \" and \", _jsx(_components.code, {\n children: \"requested\"\n }), \" do not change. \", _jsx(_components.code, {\n children: \"details.fields\"\n }), \" names each conflicting field. A field conflicts when the client changed it, a person amended it, and the new value differs from \", _jsx(_components.code, {\n children: \"current\"\n }), \". Leaving out a field the previous send set changes it to its default, so leaving out an amended field conflicts too. A change also conflicts when it would leave price fields (\", _jsx(_components.code, {\n children: \"planVersionId\"\n }), \", \", _jsx(_components.code, {\n children: \"overridePrices\"\n }), \", \", _jsx(_components.code, {\n children: \"addPrices\"\n }), \", \", _jsx(_components.code, {\n children: \"removePrices\"\n }), \", \", _jsx(_components.code, {\n children: \"adjustments\"\n }), \") naming another plan’s prices, and when it would change \", _jsx(_components.code, {\n children: \"versionPolicy\"\n }), \" while \", _jsx(_components.code, {\n children: \"planVersionId\"\n }), \" is amended.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"An approved proposal, values changed: 409 \", _jsx(_components.code, {\n children: \"SUBSCRIPTION_PROPOSAL_ALREADY_APPROVED\"\n }), \", with the subscription’s id in \", _jsx(_components.code, {\n children: \"details.subscriptionId\"\n }), \". Changes to an active subscription are not supported yet.\"]\n }), \"\\n\", _jsx(_components.li, {\n children: \"A rejected proposal, values changed: a new proposal, 201. The rejected one is unchanged.\"\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"A refused send is kept on the proposal as \", _jsx(_components.code, {\n children: \"refusedResync\"\n }), \", so a reviewer sees it. A send that repeats the stored refusal changes nothing.\"]\n })]\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 pending subscription proposal from the values of a subscription create. The customer must already exist. A plan or customer of another merchant answers 404, as an unknown one does. The values are checked as subscription create checks them, at the moment of the request, but no subscription, invoice or entitlement exists until a person approves the proposal.\n\nWith an `externalReference`, the create first finds the proposal that record already has: its pending or approved proposal, else its most recent rejected one. Sends of one record are handled one at a time. Values are compared after normalization: key order does not count, a field sent with its default equals the field left out, and two forms of one instant, such as `Z` and `+00:00`, are equal.\n\n- None found: a new proposal, 201.\n- Values equal to that proposal's `requested`: the proposal, 200. Nothing is checked. A stored `refusedResync` is cleared, which raises `lockVersion` and changes `hash`; without one, nothing is written.\n- A pending proposal, values changed: the values become the next revision and `requested`. `current` takes each changed field except a field in `amendedFields`, which keeps the person's value, and a field left out returns to its default. The result is checked as an amend is, and answered 200.\n- A pending proposal whose change conflicts with an amendment: 409 `SUBSCRIPTION_PROPOSAL_RESYNC_CONFLICT`, and `current` and `requested` do not change. `details.fields` names each conflicting field. A field conflicts when the client changed it, a person amended it, and the new value differs from `current`. Leaving out a field the previous send set changes it to its default, so leaving out an amended field conflicts too. A change also conflicts when it would leave price fields (`planVersionId`, `overridePrices`, `addPrices`, `removePrices`, `adjustments`) naming another plan's prices, and when it would change `versionPolicy` while `planVersionId` is amended.\n- An approved proposal, values changed: 409 `SUBSCRIPTION_PROPOSAL_ALREADY_APPROVED`, with the subscription's id in `details.subscriptionId`. Changes to an active subscription are not supported yet.\n- A rejected proposal, values changed: a new proposal, 201. The rejected one is unchanged.\n\nA refused send is kept on the proposal as `refusedResync`, so a reviewer sees it. A send that repeats the stored refusal changes nothing.","deprecated":null,"version":null,"openapi":"/openapi.json post /v0/subscriptionProposals","href":"/api-reference/subscription-proposals/create","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Subscription Proposals"],"summary":"Create","description":"Creates a pending subscription proposal from the values of a subscription create. The customer must already exist. A plan or customer of another merchant answers 404, as an unknown one does. The values are checked as subscription create checks them, at the moment of the request, but no subscription, invoice or entitlement exists until a person approves the proposal.\n\nWith an `externalReference`, the create first finds the proposal that record already has: its pending or approved proposal, else its most recent rejected one. Sends of one record are handled one at a time. Values are compared after normalization: key order does not count, a field sent with its default equals the field left out, and two forms of one instant, such as `Z` and `+00:00`, are equal.\n\n- None found: a new proposal, 201.\n- Values equal to that proposal's `requested`: the proposal, 200. Nothing is checked. A stored `refusedResync` is cleared, which raises `lockVersion` and changes `hash`; without one, nothing is written.\n- A pending proposal, values changed: the values become the next revision and `requested`. `current` takes each changed field except a field in `amendedFields`, which keeps the person's value, and a field left out returns to its default. The result is checked as an amend is, and answered 200.\n- A pending proposal whose change conflicts with an amendment: 409 `SUBSCRIPTION_PROPOSAL_RESYNC_CONFLICT`, and `current` and `requested` do not change. `details.fields` names each conflicting field. A field conflicts when the client changed it, a person amended it, and the new value differs from `current`. Leaving out a field the previous send set changes it to its default, so leaving out an amended field conflicts too. A change also conflicts when it would leave price fields (`planVersionId`, `overridePrices`, `addPrices`, `removePrices`, `adjustments`) naming another plan's prices, and when it would change `versionPolicy` while `planVersionId` is amended.\n- An approved proposal, values changed: 409 `SUBSCRIPTION_PROPOSAL_ALREADY_APPROVED`, with the subscription's id in `details.subscriptionId`. Changes to an active subscription are not supported yet.\n- A rejected proposal, values changed: a new proposal, 201. The rejected one is unchanged.\n\nA refused send is kept on the proposal as `refusedResync`, so a reviewer sees it. A send that repeats the stored refusal changes nothing.","operationId":"createSubscriptionProposal","requestBody":"3ee4ccd7-7843-45c8-a2c1-0d7badac55bb","responses":{"200":"3bd442c4-9ec2-4ad2-98f6-344c062f3427","201":"9149c62e-835d-4a34-ae29-0f0466516942","400":"e6e33e0a-586e-496a-b6b2-eefad1cfe0e4","401":"cf8d310b-5572-4b50-ad1c-a2c865f0b79c","403":"6f62397a-782a-484e-b6a5-5a46b82320db","404":"72d36434-5a8b-43dd-872c-28f56dcc3bb8","409":"dc29ccbe-ae6e-429f-915b-db47f8e150fa","429":"ddce70b5-8c6f-4f08-be81-b11ef3f848f2","500":"7f5040a0-3aac-4a72-89d2-b1f97fa59d6a"},"x-permission":"subscriptionProposals:write","method":"post","type":"path","servers":["0ff10ce3-51b6-430b-80a4-c0988a44c6e6","d6c1ad05-2e8d-47a6-968b-204465b448ac"],"security":["5c888a87-14a3-4f77-a118-202bb1f6a955"],"path":"/v0/subscriptionProposals","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","customerId","name","startedAt"],"additionalProperties":false,"properties":{"customerId":{"type":"string","pattern":"^cus_[a-zA-Z0-9]+$","description":"Unique identifier for a customer","isRequired":true,"uniqueKey":"customerId","typeLabel":"string"},"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"},"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":{"title":"CreateSubscriptionProposalRedirectUrls","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":"CreateSubscriptionProposalRedirectUrls · 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\"). A non-zero value needs `metadata.bankTransferOnly: true`; without it the request answers 400 `PAYMENT_TERM_DAYS_REQUIRES_BANK_TRANSFER_ONLY`.","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.","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[]"},"planVersionId":{"type":"string","description":"A published version of `planId` to pin the proposal to. Only a pinned proposal (`versionPolicy: \"pinned\"`) names a version. One that names none, or `null`, pins the plan's default version, as a change of `planId` without a version does. A floating proposal follows the plan's default version, and one that names a version is refused with 400.","uniqueKey":"planVersionId","typeLabel":"string"},"adjustments":{"type":"array","maxItems":25,"items":{"oneOf":[{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","percentageDiscount","effectiveFrom"],"properties":{"type":{"type":"string","enum":["percentageDiscount"],"description":"Reduces every discountable charge on the invoice by a rate.","isRequired":true,"uniqueKey":"adjustments.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"percentageDiscount":{"type":"string","description":"The discount rate as a decimal fraction between 0 and 1, sent as a string. \"0.35\" means 35 percent. \"1\" means 100 percent, not 1 percent. At most 6 decimal places. A value of 0 or above 1 is rejected.","isRequired":true,"uniqueKey":"adjustments.items.[INDEX].oneOf.0.percentageDiscount","typeLabel":"string"},"effectiveFrom":{"type":"string","format":"date-time","description":"The first instant the discount applies. Inclusive.","isRequired":true,"uniqueKey":"adjustments.items.[INDEX].oneOf.0.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"The instant the discount stops applying. Exclusive, so a window ending on the same date another begins neither overlaps nor leaves a gap. Null means the discount never stops, and it cannot be ended later — set an instant whenever the deal has a known end date. Must be after effectiveFrom.","uniqueKey":"adjustments.items.[INDEX].oneOf.0.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The instant the discount stops applying. Exclusive, so a window ending on the same date another begins neither overlaps nor leaves a gap. Null means the discount never stops, and it cannot be ended later — set an instant whenever the deal has a known end date. Must be after effectiveFrom.","uniqueKey":"adjustments.items.[INDEX].oneOf.0.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"adjustments.items.[INDEX].oneOf.0.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"The deal's own name, shown on each discount line of the invoice.","uniqueKey":"adjustments.items.[INDEX].oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The deal's own name, shown on each discount line of the invoice.","uniqueKey":"adjustments.items.[INDEX].oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"adjustments.items.[INDEX].oneOf.0.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second adjustment, and two percentage discounts compound — two of 0.35 bill 57.75 percent off, not 35 percent.","example":"adj_fy26_growth_001","uniqueKey":"adjustments.items.[INDEX].oneOf.0.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"adjustments.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","usageDiscount","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["usageDiscount"],"description":"Reduces one metered price's billable quantity by a number of usage units, before the line is priced.","isRequired":true,"uniqueKey":"adjustments.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"usageDiscount":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The number of usage units to take off the billable quantity, sent as a plain decimal string. \"300\" waives 300 units. Greater than 0, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. Applied in full or not at all — a unit count is never prorated across a partial window — and once per matching line, so an invoice bundling several periods is corrected on each of them. The line is floored at 0, so a discount larger than the billable quantity zeroes it rather than crediting. On a volume ladder the corrected quantity also re-selects the band, so a waiver that crosses a boundary can bill more than the uncorrected line did: waiving 300 of 1000 units on a ladder of 2.00 up to 999 and 1.00 beyond bills 700 at 2.00 for 1400.00, where the 1000 units billed 1000.00. That is the ladder's price for the corrected usage — what a customer who genuinely used 700 units pays — so check the ladder before waiving units near a band boundary.","isRequired":true,"uniqueKey":"adjustments.items.[INDEX].oneOf.1.usageDiscount","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"adjustments.items.[INDEX].oneOf.1.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one metered price of this subscription, priced as standard or volume. Usage units are not comparable across metrics, so a usage discount names the one price it reduces. A dynamic or percentage price is refused: its quantity is a monetary amount rather than a unit count. A price billing at a negative rate (a usage-scaled rebate) is refused too, because removing its units would raise the invoice.","isRequired":true,"uniqueKey":"adjustments.items.[INDEX].oneOf.1.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a metered line is corrected when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. Set it to the start of the period you are correcting.","isRequired":true,"uniqueKey":"adjustments.items.[INDEX].oneOf.1.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, unlike percentageDiscount: a metered line bills in arrears, so set this to the exact period end you are correcting and that period is covered. Null means the discount never stops — it then takes its full unit count off this price on EVERY later invoice, so set both bounds whenever you are correcting one period. Must be after effectiveFrom.","uniqueKey":"adjustments.items.[INDEX].oneOf.1.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, unlike percentageDiscount: a metered line bills in arrears, so set this to the exact period end you are correcting and that period is covered. Null means the discount never stops — it then takes its full unit count off this price on EVERY later invoice, so set both bounds whenever you are correcting one period. Must be after effectiveFrom.","uniqueKey":"adjustments.items.[INDEX].oneOf.1.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"adjustments.items.[INDEX].oneOf.1.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this correction. A usageDiscount emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"adjustments.items.[INDEX].oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this correction. A usageDiscount emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"adjustments.items.[INDEX].oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"adjustments.items.[INDEX].oneOf.1.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second adjustment, and usage discounts against one price SUM — two of \"300\" waive 600 units, not 300. Nothing else detects a duplicate.","example":"adj_mar_outage_001","uniqueKey":"adjustments.items.[INDEX].oneOf.1.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"adjustments.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","minimumQuantity","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["minimumQuantity"],"description":"Bills at least the contracted quantity on one price, whatever the customer actually used.","isRequired":true,"uniqueKey":"adjustments.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"minimumQuantity":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The contracted minimum quantity for one billing period of the target price, sent as a plain decimal string. Not negative, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. \"4\" bills 4 seats in a period the customer used 2 in; a value of 0 binds nothing. Measured over the whole billing period, not per line: where a period is split into several lines, each line's quantity counts for its share of the period, and every line is scaled by the same factor to bring the period to the minimum. Several bounds of the same direction on one price do not add up — the greatest minimum and the least maximum are the ones that apply.","isRequired":true,"uniqueKey":"adjustments.items.[INDEX].oneOf.2.minimumQuantity","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"adjustments.items.[INDEX].oneOf.2.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one price of this subscription. A metered price is accepted, and so is a price whose supply is outside the scope of VAT: a bound constrains a measurement rather than an amount of consideration. A price that bills once rather than per period is refused, because there is no repeating period for the bound to be measured over.","isRequired":true,"uniqueKey":"adjustments.items.[INDEX].oneOf.2.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a line is bounded when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. The bound is never prorated — a window opening mid-period applies to that whole period.","isRequired":true,"uniqueKey":"adjustments.items.[INDEX].oneOf.2.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"adjustments.items.[INDEX].oneOf.2.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"adjustments.items.[INDEX].oneOf.2.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"adjustments.items.[INDEX].oneOf.2.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"adjustments.items.[INDEX].oneOf.2.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"adjustments.items.[INDEX].oneOf.2.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"adjustments.items.[INDEX].oneOf.2.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second bound; two identical bounds change nothing, because bounds of one direction do not add up.","example":"adj_fortress_seats_001","uniqueKey":"adjustments.items.[INDEX].oneOf.2.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"adjustments.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","maximumQuantity","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["maximumQuantity"],"description":"Bills at most the contracted quantity on one price, whatever the customer actually used.","isRequired":true,"uniqueKey":"adjustments.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"maximumQuantity":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The contracted maximum quantity for one billing period of the target price, sent as a plain decimal string. Not negative, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. \"4\" bills 4 seats in a period the customer used 9 in; a value of 0 bills nothing at all. Measured over the whole billing period, not per line: where a period is split into several lines, each line's quantity counts for its share of the period, and every line is scaled by the same factor to bring the period to the maximum. Several bounds of the same direction on one price do not add up — the greatest minimum and the least maximum are the ones that apply.","isRequired":true,"uniqueKey":"adjustments.items.[INDEX].oneOf.3.maximumQuantity","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"adjustments.items.[INDEX].oneOf.3.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one price of this subscription. A metered price is accepted, and so is a price whose supply is outside the scope of VAT: a bound constrains a measurement rather than an amount of consideration. A price that bills once rather than per period is refused, because there is no repeating period for the bound to be measured over.","isRequired":true,"uniqueKey":"adjustments.items.[INDEX].oneOf.3.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a line is bounded when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. The bound is never prorated — a window opening mid-period applies to that whole period.","isRequired":true,"uniqueKey":"adjustments.items.[INDEX].oneOf.3.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"adjustments.items.[INDEX].oneOf.3.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"adjustments.items.[INDEX].oneOf.3.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"adjustments.items.[INDEX].oneOf.3.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"adjustments.items.[INDEX].oneOf.3.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"adjustments.items.[INDEX].oneOf.3.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"adjustments.items.[INDEX].oneOf.3.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second bound; two identical bounds change nothing, because bounds of one direction do not add up.","example":"adj_fortress_seats_001","uniqueKey":"adjustments.items.[INDEX].oneOf.3.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"adjustments.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"adjustments.items.[INDEX]","typeLabel":"object"},"description":"Adjustments the subscription gets when the proposal is approved. Each is checked as subscription adjustment create checks it, against the prices the proposal bills and the other adjustments in this list.","uniqueKey":"adjustments","typeLabel":"object[]"},"externalReference":{"type":"object","description":"The record in another system, such as a CRM deal, that the proposal comes from. A create naming a record that already has a proposal acts on that proposal, as the create operation describes.","required":["provider","externalId"],"additionalProperties":false,"properties":{"provider":{"type":"string","pattern":"^[a-z][a-z0-9_]*$","maxLength":64,"description":"Lowercase snake_case provider identifier (e.g. `salesforce`, `netsuite`)","isRequired":true,"uniqueKey":"externalReference.provider","typeLabel":"string"},"externalId":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","maxLength":255,"description":"Optional external identifier for cross-referencing with external systems. Alphanumeric characters, hyphens, and underscores only.","isRequired":true,"uniqueKey":"externalReference.externalId","typeLabel":"string"}},"uniqueKey":"externalReference","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"customerId":"\u003cstring>","name":"\u003cstring>","planId":"\u003cstring>","startedAt":"2023-11-07T05:31:56Z","autoCharge":false,"taxExempt":false,"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>"}],"planVersionId":"\u003cstring>","adjustments":[{"type":"percentageDiscount","percentageDiscount":"\u003cstring>","effectiveFrom":"2023-11-07T05:31:56Z","effectiveTo":"2023-11-07T05:31:56Z","description":"\u003cstring>","idempotencyKey":"adj_fy26_growth_001"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"3bd442c4-9ec2-4ad2-98f6-344c062f3427":{"description":"The proposal the external reference already has, unchanged or re-synced","content":{"application/json":{"schema":{"type":"object","description":"A subscription a client proposed, held until a person approves or rejects it. No subscription exists until it is approved.","required":["id","object","merchantId","status","customerId","planId","planVersionId","resolvedPlanVersionId","hash","testClockId","requested","current","amendedFields","refusedResync","lockVersion","source","externalReference","subscriptionId","rejectionReason","rejectionText","decidedAt","decidedByPrincipalId","decidedBy","strandedAt","createdByPrincipalId","createdByCredentialId","createdAt","updatedAt"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","enum":["subscriptionProposal"],"isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"merchantId":{"type":"string","pattern":"^org_[a-zA-Z0-9]+$","description":"Unique identifier for an organization","isRequired":true,"uniqueKey":"merchantId","typeLabel":"string"},"status":{"type":"string","enum":["pending","approved","rejected"],"description":"`pending` until a person approves or rejects the proposal.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"customerId":{"type":"string","pattern":"^cus_[a-zA-Z0-9]+$","description":"Unique identifier for a customer","isRequired":true,"uniqueKey":"customerId","typeLabel":"string"},"planId":{"type":"string","pattern":"^plan_[a-zA-Z0-9]+$","description":"Unique identifier for a plan","isRequired":true,"uniqueKey":"planId","typeLabel":"string"},"planVersionId":{"oneOf":[{"type":"string","description":"The plan version a pinned proposal is pinned to. Null for a floating proposal, which follows the plan's default version.","isRequired":true,"uniqueKey":"planVersionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The plan version a pinned proposal is pinned to. Null for a floating proposal, which follows the plan's default version.","isRequired":true,"uniqueKey":"planVersionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"planVersionId","typeLabel":"string | null"},"resolvedPlanVersionId":{"oneOf":[{"type":"string","description":"The plan version approve would use now: `planVersionId` when pinned, else the plan's default version. Null when the plan has no published version.","isRequired":true,"uniqueKey":"resolvedPlanVersionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The plan version approve would use now: `planVersionId` when pinned, else the plan's default version. Null when the plan has no published version.","isRequired":true,"uniqueKey":"resolvedPlanVersionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"resolvedPlanVersionId","typeLabel":"string | null"},"hash":{"type":"string","description":"Changes whenever `current` or `resolvedPlanVersionId` changes. A decision sends it as `basedOnHash`, so a person only decides on the proposal they read.","isRequired":true,"uniqueKey":"hash","typeLabel":"string"},"testClockId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"testClockId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"testClockId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"testClockId","typeLabel":"string | null"},"requested":{"type":"object","additionalProperties":false,"description":"The values as the client last sent them, without `externalReference`.","required":["planId","customerId","name","startedAt"],"properties":{"customerId":{"type":"string","pattern":"^cus_[a-zA-Z0-9]+$","description":"Unique identifier for a customer","isRequired":true,"uniqueKey":"requested.customerId","typeLabel":"string"},"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":"requested.name","typeLabel":"string"},"planId":{"type":"string","pattern":"^plan_[a-zA-Z0-9]+$","description":"Unique identifier for a plan","isRequired":true,"uniqueKey":"requested.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":"requested.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.","uniqueKey":"requested.autoCharge","typeLabel":"boolean"},"taxExempt":{"type":"boolean","description":"When true, forces tax rate to 0%. Use for customers with verified tax-exempt status.","uniqueKey":"requested.taxExempt","typeLabel":"boolean"},"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":"requested.endingAt","typeLabel":"string\u003cdate-time>"},"prefundAmount":{"type":"string","deprecated":true,"description":"Deprecated. This field is ignored and has no effect.","uniqueKey":"requested.prefundAmount","typeLabel":"string"},"minimumAccountBalance":{"type":"string","deprecated":true,"description":"Deprecated. This field is ignored and has no effect.","uniqueKey":"requested.minimumAccountBalance","typeLabel":"string"},"redirectUrls":{"title":"SubscriptionProposalRedirectUrls","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":"requested.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":"requested.redirectUrls.onFailure","typeLabel":"string\u003curi>"}},"uniqueKey":"requested.redirectUrls","typeLabel":"SubscriptionProposalRedirectUrls · object"},"elapsedPeriodBilling":{"type":"string","enum":["none","per_period"],"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":"requested.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":"requested.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":"requested.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":"requested.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":"requested.renewalReminderEnabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"requested.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":"requested.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":"requested.renewalReminderDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"requested.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\"). A non-zero value needs `metadata.bankTransferOnly: true`; without it the request answers 400 `PAYMENT_TERM_DAYS_REQUIRES_BANK_TRANSFER_ONLY`.","minimum":0,"maximum":365,"uniqueKey":"requested.paymentTermDays","typeLabel":"integer"},"sessionExpiryMinutes":{"type":"number","description":"Number of minutes until the payment session expires. Defaults to 240 minutes (4 hours) if not provided.","minimum":1,"uniqueKey":"requested.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":"requested.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":"requested.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"requested.metadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"requested.metadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"requested.metadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"requested.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":"requested.changeReason","typeLabel":"enum\u003cstring>"},"changeDescription":{"type":"string","maxLength":1000,"description":"A free-text note on why these intervals are changing.","uniqueKey":"requested.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":"requested.changeMetadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","maxLength":500,"uniqueKey":"requested.changeMetadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","maxLength":500,"uniqueKey":"requested.changeMetadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"requested.changeMetadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"requested.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":"requested.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":"requested.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":"requested.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":"requested.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":"requested.addPrices.items.[INDEX].installments","typeLabel":"integer"},"amounts":{"type":"array","minItems":2,"maxItems":60,"items":{"type":"string","uniqueKey":"requested.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":"requested.addPrices.items.[INDEX].amounts","typeLabel":"string[]"}},"uniqueKey":"requested.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":"requested.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":"requested.overridePrices.items.[INDEX].overridesPriceId","typeLabel":"string"},"unitPrice":{"type":"string","description":"The agreed rate, as a decimal string.","uniqueKey":"requested.overridePrices.items.[INDEX].unitPrice","typeLabel":"string"},"baseQuantity":{"type":"string","description":"The agreed quantity, as a decimal string.","uniqueKey":"requested.overridePrices.items.[INDEX].baseQuantity","typeLabel":"string"}},"uniqueKey":"requested.overridePrices.items.[INDEX]","typeLabel":"object"},"description":"Rate or quantity overrides for prices the plan version does carry.","uniqueKey":"requested.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":"requested.removePrices.items.[INDEX].priceId","typeLabel":"string"}},"uniqueKey":"requested.removePrices.items.[INDEX]","typeLabel":"object"},"description":"Plan prices this subscription does not bill.","uniqueKey":"requested.removePrices","typeLabel":"object[]"},"planVersionId":{"type":"string","description":"A published version of `planId` to pin the proposal to. Only a pinned proposal (`versionPolicy: \"pinned\"`) names a version. One that names none, or `null`, pins the plan's default version, as a change of `planId` without a version does. A floating proposal follows the plan's default version, and one that names a version is refused with 400.","uniqueKey":"requested.planVersionId","typeLabel":"string"},"adjustments":{"type":"array","maxItems":25,"items":{"oneOf":[{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","percentageDiscount","effectiveFrom"],"properties":{"type":{"type":"string","enum":["percentageDiscount"],"description":"Reduces every discountable charge on the invoice by a rate.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"percentageDiscount":{"type":"string","description":"The discount rate as a decimal fraction between 0 and 1, sent as a string. \"0.35\" means 35 percent. \"1\" means 100 percent, not 1 percent. At most 6 decimal places. A value of 0 or above 1 is rejected.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0.percentageDiscount","typeLabel":"string"},"effectiveFrom":{"type":"string","format":"date-time","description":"The first instant the discount applies. Inclusive.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"The instant the discount stops applying. Exclusive, so a window ending on the same date another begins neither overlaps nor leaves a gap. Null means the discount never stops, and it cannot be ended later — set an instant whenever the deal has a known end date. Must be after effectiveFrom.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The instant the discount stops applying. Exclusive, so a window ending on the same date another begins neither overlaps nor leaves a gap. Null means the discount never stops, and it cannot be ended later — set an instant whenever the deal has a known end date. Must be after effectiveFrom.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"The deal's own name, shown on each discount line of the invoice.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The deal's own name, shown on each discount line of the invoice.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second adjustment, and two percentage discounts compound — two of 0.35 bill 57.75 percent off, not 35 percent.","example":"adj_fy26_growth_001","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","usageDiscount","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["usageDiscount"],"description":"Reduces one metered price's billable quantity by a number of usage units, before the line is priced.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"usageDiscount":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The number of usage units to take off the billable quantity, sent as a plain decimal string. \"300\" waives 300 units. Greater than 0, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. Applied in full or not at all — a unit count is never prorated across a partial window — and once per matching line, so an invoice bundling several periods is corrected on each of them. The line is floored at 0, so a discount larger than the billable quantity zeroes it rather than crediting. On a volume ladder the corrected quantity also re-selects the band, so a waiver that crosses a boundary can bill more than the uncorrected line did: waiving 300 of 1000 units on a ladder of 2.00 up to 999 and 1.00 beyond bills 700 at 2.00 for 1400.00, where the 1000 units billed 1000.00. That is the ladder's price for the corrected usage — what a customer who genuinely used 700 units pays — so check the ladder before waiving units near a band boundary.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.usageDiscount","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one metered price of this subscription, priced as standard or volume. Usage units are not comparable across metrics, so a usage discount names the one price it reduces. A dynamic or percentage price is refused: its quantity is a monetary amount rather than a unit count. A price billing at a negative rate (a usage-scaled rebate) is refused too, because removing its units would raise the invoice.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a metered line is corrected when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. Set it to the start of the period you are correcting.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, unlike percentageDiscount: a metered line bills in arrears, so set this to the exact period end you are correcting and that period is covered. Null means the discount never stops — it then takes its full unit count off this price on EVERY later invoice, so set both bounds whenever you are correcting one period. Must be after effectiveFrom.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, unlike percentageDiscount: a metered line bills in arrears, so set this to the exact period end you are correcting and that period is covered. Null means the discount never stops — it then takes its full unit count off this price on EVERY later invoice, so set both bounds whenever you are correcting one period. Must be after effectiveFrom.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this correction. A usageDiscount emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this correction. A usageDiscount emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second adjustment, and usage discounts against one price SUM — two of \"300\" waive 600 units, not 300. Nothing else detects a duplicate.","example":"adj_mar_outage_001","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","minimumQuantity","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["minimumQuantity"],"description":"Bills at least the contracted quantity on one price, whatever the customer actually used.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"minimumQuantity":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The contracted minimum quantity for one billing period of the target price, sent as a plain decimal string. Not negative, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. \"4\" bills 4 seats in a period the customer used 2 in; a value of 0 binds nothing. Measured over the whole billing period, not per line: where a period is split into several lines, each line's quantity counts for its share of the period, and every line is scaled by the same factor to bring the period to the minimum. Several bounds of the same direction on one price do not add up — the greatest minimum and the least maximum are the ones that apply.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.minimumQuantity","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one price of this subscription. A metered price is accepted, and so is a price whose supply is outside the scope of VAT: a bound constrains a measurement rather than an amount of consideration. A price that bills once rather than per period is refused, because there is no repeating period for the bound to be measured over.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a line is bounded when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. The bound is never prorated — a window opening mid-period applies to that whole period.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second bound; two identical bounds change nothing, because bounds of one direction do not add up.","example":"adj_fortress_seats_001","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","maximumQuantity","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["maximumQuantity"],"description":"Bills at most the contracted quantity on one price, whatever the customer actually used.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"maximumQuantity":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The contracted maximum quantity for one billing period of the target price, sent as a plain decimal string. Not negative, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. \"4\" bills 4 seats in a period the customer used 9 in; a value of 0 bills nothing at all. Measured over the whole billing period, not per line: where a period is split into several lines, each line's quantity counts for its share of the period, and every line is scaled by the same factor to bring the period to the maximum. Several bounds of the same direction on one price do not add up — the greatest minimum and the least maximum are the ones that apply.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.maximumQuantity","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one price of this subscription. A metered price is accepted, and so is a price whose supply is outside the scope of VAT: a bound constrains a measurement rather than an amount of consideration. A price that bills once rather than per period is refused, because there is no repeating period for the bound to be measured over.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a line is bounded when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. The bound is never prorated — a window opening mid-period applies to that whole period.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second bound; two identical bounds change nothing, because bounds of one direction do not add up.","example":"adj_fortress_seats_001","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"requested.adjustments.items.[INDEX]","typeLabel":"object"},"description":"Adjustments the subscription gets when the proposal is approved. Each is checked as subscription adjustment create checks it, against the prices the proposal bills and the other adjustments in this list.","uniqueKey":"requested.adjustments","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"requested","typeLabel":"object"},"current":{"type":"object","additionalProperties":false,"description":"The values as they are now, amendments included, with `planVersionId` when the proposal is pinned. Approve creates the subscription from them.","required":["planId","customerId","name","startedAt"],"properties":{"customerId":{"type":"string","pattern":"^cus_[a-zA-Z0-9]+$","description":"Unique identifier for a customer","isRequired":true,"uniqueKey":"current.customerId","typeLabel":"string"},"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":"current.name","typeLabel":"string"},"planId":{"type":"string","pattern":"^plan_[a-zA-Z0-9]+$","description":"Unique identifier for a plan","isRequired":true,"uniqueKey":"current.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":"current.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.","uniqueKey":"current.autoCharge","typeLabel":"boolean"},"taxExempt":{"type":"boolean","description":"When true, forces tax rate to 0%. Use for customers with verified tax-exempt status.","uniqueKey":"current.taxExempt","typeLabel":"boolean"},"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":"current.endingAt","typeLabel":"string\u003cdate-time>"},"prefundAmount":{"type":"string","deprecated":true,"description":"Deprecated. This field is ignored and has no effect.","uniqueKey":"current.prefundAmount","typeLabel":"string"},"minimumAccountBalance":{"type":"string","deprecated":true,"description":"Deprecated. This field is ignored and has no effect.","uniqueKey":"current.minimumAccountBalance","typeLabel":"string"},"redirectUrls":{"title":"SubscriptionProposalRedirectUrls","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":"current.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":"current.redirectUrls.onFailure","typeLabel":"string\u003curi>"}},"uniqueKey":"current.redirectUrls","typeLabel":"SubscriptionProposalRedirectUrls · object"},"elapsedPeriodBilling":{"type":"string","enum":["none","per_period"],"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":"current.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":"current.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":"current.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":"current.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":"current.renewalReminderEnabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"current.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":"current.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":"current.renewalReminderDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"current.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\"). A non-zero value needs `metadata.bankTransferOnly: true`; without it the request answers 400 `PAYMENT_TERM_DAYS_REQUIRES_BANK_TRANSFER_ONLY`.","minimum":0,"maximum":365,"uniqueKey":"current.paymentTermDays","typeLabel":"integer"},"sessionExpiryMinutes":{"type":"number","description":"Number of minutes until the payment session expires. Defaults to 240 minutes (4 hours) if not provided.","minimum":1,"uniqueKey":"current.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":"current.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":"current.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"current.metadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"current.metadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"current.metadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"current.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":"current.changeReason","typeLabel":"enum\u003cstring>"},"changeDescription":{"type":"string","maxLength":1000,"description":"A free-text note on why these intervals are changing.","uniqueKey":"current.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":"current.changeMetadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","maxLength":500,"uniqueKey":"current.changeMetadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","maxLength":500,"uniqueKey":"current.changeMetadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"current.changeMetadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"current.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":"current.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":"current.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":"current.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":"current.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":"current.addPrices.items.[INDEX].installments","typeLabel":"integer"},"amounts":{"type":"array","minItems":2,"maxItems":60,"items":{"type":"string","uniqueKey":"current.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":"current.addPrices.items.[INDEX].amounts","typeLabel":"string[]"}},"uniqueKey":"current.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":"current.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":"current.overridePrices.items.[INDEX].overridesPriceId","typeLabel":"string"},"unitPrice":{"type":"string","description":"The agreed rate, as a decimal string.","uniqueKey":"current.overridePrices.items.[INDEX].unitPrice","typeLabel":"string"},"baseQuantity":{"type":"string","description":"The agreed quantity, as a decimal string.","uniqueKey":"current.overridePrices.items.[INDEX].baseQuantity","typeLabel":"string"}},"uniqueKey":"current.overridePrices.items.[INDEX]","typeLabel":"object"},"description":"Rate or quantity overrides for prices the plan version does carry.","uniqueKey":"current.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":"current.removePrices.items.[INDEX].priceId","typeLabel":"string"}},"uniqueKey":"current.removePrices.items.[INDEX]","typeLabel":"object"},"description":"Plan prices this subscription does not bill.","uniqueKey":"current.removePrices","typeLabel":"object[]"},"planVersionId":{"type":"string","description":"A published version of `planId` to pin the proposal to. Only a pinned proposal (`versionPolicy: \"pinned\"`) names a version. One that names none, or `null`, pins the plan's default version, as a change of `planId` without a version does. A floating proposal follows the plan's default version, and one that names a version is refused with 400.","uniqueKey":"current.planVersionId","typeLabel":"string"},"adjustments":{"type":"array","maxItems":25,"items":{"oneOf":[{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","percentageDiscount","effectiveFrom"],"properties":{"type":{"type":"string","enum":["percentageDiscount"],"description":"Reduces every discountable charge on the invoice by a rate.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"percentageDiscount":{"type":"string","description":"The discount rate as a decimal fraction between 0 and 1, sent as a string. \"0.35\" means 35 percent. \"1\" means 100 percent, not 1 percent. At most 6 decimal places. A value of 0 or above 1 is rejected.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.0.percentageDiscount","typeLabel":"string"},"effectiveFrom":{"type":"string","format":"date-time","description":"The first instant the discount applies. Inclusive.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.0.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"The instant the discount stops applying. Exclusive, so a window ending on the same date another begins neither overlaps nor leaves a gap. Null means the discount never stops, and it cannot be ended later — set an instant whenever the deal has a known end date. Must be after effectiveFrom.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.0.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The instant the discount stops applying. Exclusive, so a window ending on the same date another begins neither overlaps nor leaves a gap. Null means the discount never stops, and it cannot be ended later — set an instant whenever the deal has a known end date. Must be after effectiveFrom.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.0.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"current.adjustments.items.[INDEX].oneOf.0.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"The deal's own name, shown on each discount line of the invoice.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The deal's own name, shown on each discount line of the invoice.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"current.adjustments.items.[INDEX].oneOf.0.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second adjustment, and two percentage discounts compound — two of 0.35 bill 57.75 percent off, not 35 percent.","example":"adj_fy26_growth_001","uniqueKey":"current.adjustments.items.[INDEX].oneOf.0.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","usageDiscount","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["usageDiscount"],"description":"Reduces one metered price's billable quantity by a number of usage units, before the line is priced.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"usageDiscount":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The number of usage units to take off the billable quantity, sent as a plain decimal string. \"300\" waives 300 units. Greater than 0, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. Applied in full or not at all — a unit count is never prorated across a partial window — and once per matching line, so an invoice bundling several periods is corrected on each of them. The line is floored at 0, so a discount larger than the billable quantity zeroes it rather than crediting. On a volume ladder the corrected quantity also re-selects the band, so a waiver that crosses a boundary can bill more than the uncorrected line did: waiving 300 of 1000 units on a ladder of 2.00 up to 999 and 1.00 beyond bills 700 at 2.00 for 1400.00, where the 1000 units billed 1000.00. That is the ladder's price for the corrected usage — what a customer who genuinely used 700 units pays — so check the ladder before waiving units near a band boundary.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.usageDiscount","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one metered price of this subscription, priced as standard or volume. Usage units are not comparable across metrics, so a usage discount names the one price it reduces. A dynamic or percentage price is refused: its quantity is a monetary amount rather than a unit count. A price billing at a negative rate (a usage-scaled rebate) is refused too, because removing its units would raise the invoice.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a metered line is corrected when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. Set it to the start of the period you are correcting.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, unlike percentageDiscount: a metered line bills in arrears, so set this to the exact period end you are correcting and that period is covered. Null means the discount never stops — it then takes its full unit count off this price on EVERY later invoice, so set both bounds whenever you are correcting one period. Must be after effectiveFrom.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, unlike percentageDiscount: a metered line bills in arrears, so set this to the exact period end you are correcting and that period is covered. Null means the discount never stops — it then takes its full unit count off this price on EVERY later invoice, so set both bounds whenever you are correcting one period. Must be after effectiveFrom.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this correction. A usageDiscount emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this correction. A usageDiscount emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second adjustment, and usage discounts against one price SUM — two of \"300\" waive 600 units, not 300. Nothing else detects a duplicate.","example":"adj_mar_outage_001","uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","minimumQuantity","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["minimumQuantity"],"description":"Bills at least the contracted quantity on one price, whatever the customer actually used.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"minimumQuantity":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The contracted minimum quantity for one billing period of the target price, sent as a plain decimal string. Not negative, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. \"4\" bills 4 seats in a period the customer used 2 in; a value of 0 binds nothing. Measured over the whole billing period, not per line: where a period is split into several lines, each line's quantity counts for its share of the period, and every line is scaled by the same factor to bring the period to the minimum. Several bounds of the same direction on one price do not add up — the greatest minimum and the least maximum are the ones that apply.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.minimumQuantity","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one price of this subscription. A metered price is accepted, and so is a price whose supply is outside the scope of VAT: a bound constrains a measurement rather than an amount of consideration. A price that bills once rather than per period is refused, because there is no repeating period for the bound to be measured over.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a line is bounded when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. The bound is never prorated — a window opening mid-period applies to that whole period.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second bound; two identical bounds change nothing, because bounds of one direction do not add up.","example":"adj_fortress_seats_001","uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","maximumQuantity","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["maximumQuantity"],"description":"Bills at most the contracted quantity on one price, whatever the customer actually used.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"maximumQuantity":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The contracted maximum quantity for one billing period of the target price, sent as a plain decimal string. Not negative, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. \"4\" bills 4 seats in a period the customer used 9 in; a value of 0 bills nothing at all. Measured over the whole billing period, not per line: where a period is split into several lines, each line's quantity counts for its share of the period, and every line is scaled by the same factor to bring the period to the maximum. Several bounds of the same direction on one price do not add up — the greatest minimum and the least maximum are the ones that apply.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.maximumQuantity","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one price of this subscription. A metered price is accepted, and so is a price whose supply is outside the scope of VAT: a bound constrains a measurement rather than an amount of consideration. A price that bills once rather than per period is refused, because there is no repeating period for the bound to be measured over.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a line is bounded when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. The bound is never prorated — a window opening mid-period applies to that whole period.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second bound; two identical bounds change nothing, because bounds of one direction do not add up.","example":"adj_fortress_seats_001","uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"current.adjustments.items.[INDEX]","typeLabel":"object"},"description":"Adjustments the subscription gets when the proposal is approved. Each is checked as subscription adjustment create checks it, against the prices the proposal bills and the other adjustments in this list.","uniqueKey":"current.adjustments","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"current","typeLabel":"object"},"amendedFields":{"type":"array","items":{"type":"string","uniqueKey":"amendedFields.items.[INDEX]","typeLabel":"string"},"description":"The top-level fields a person amended. A re-send of the external reference keeps the person's value for each; a field stays amended when the client sends the person's value.","isRequired":true,"uniqueKey":"amendedFields","typeLabel":"string[]"},"refusedResync":{"oneOf":[{"type":"object","description":"The CRM's latest refused re-sync, or null. It changes `hash`, so a decision made before it arrived answers 409 `SUBSCRIPTION_PROPOSAL_CHANGED`.","required":["receivedAt","code","fields","values","credentialId"],"properties":{"receivedAt":{"type":"string","format":"date-time","description":"When the refused values arrived.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.receivedAt","typeLabel":"string\u003cdate-time>"},"code":{"type":"string","enum":["SUBSCRIPTION_PROPOSAL_RESYNC_CONFLICT","SUBSCRIPTION_PROPOSAL_ALREADY_APPROVED"],"description":"The code of the 409 the send answered.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.code","typeLabel":"enum\u003cstring>"},"fields":{"type":"array","items":{"type":"string","uniqueKey":"refusedResync.oneOf.0.fields.items.[INDEX]","typeLabel":"string"},"description":"The fields that conflict with an amendment, or on an approved proposal the fields the CRM changed.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.fields","typeLabel":"string[]"},"values":{"type":"object","additionalProperties":false,"description":"The values the CRM sent, without `externalReference`.","required":["planId","customerId","name","startedAt"],"properties":{"customerId":{"type":"string","pattern":"^cus_[a-zA-Z0-9]+$","description":"Unique identifier for a customer","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.customerId","typeLabel":"string"},"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":"refusedResync.oneOf.0.values.name","typeLabel":"string"},"planId":{"type":"string","pattern":"^plan_[a-zA-Z0-9]+$","description":"Unique identifier for a plan","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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.","uniqueKey":"refusedResync.oneOf.0.values.autoCharge","typeLabel":"boolean"},"taxExempt":{"type":"boolean","description":"When true, forces tax rate to 0%. Use for customers with verified tax-exempt status.","uniqueKey":"refusedResync.oneOf.0.values.taxExempt","typeLabel":"boolean"},"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":"refusedResync.oneOf.0.values.endingAt","typeLabel":"string\u003cdate-time>"},"prefundAmount":{"type":"string","deprecated":true,"description":"Deprecated. This field is ignored and has no effect.","uniqueKey":"refusedResync.oneOf.0.values.prefundAmount","typeLabel":"string"},"minimumAccountBalance":{"type":"string","deprecated":true,"description":"Deprecated. This field is ignored and has no effect.","uniqueKey":"refusedResync.oneOf.0.values.minimumAccountBalance","typeLabel":"string"},"redirectUrls":{"title":"SubscriptionProposalRedirectUrls","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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.redirectUrls.onFailure","typeLabel":"string\u003curi>"}},"uniqueKey":"refusedResync.oneOf.0.values.redirectUrls","typeLabel":"SubscriptionProposalRedirectUrls · object"},"elapsedPeriodBilling":{"type":"string","enum":["none","per_period"],"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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.renewalReminderEnabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.renewalReminderDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"refusedResync.oneOf.0.values.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\"). A non-zero value needs `metadata.bankTransferOnly: true`; without it the request answers 400 `PAYMENT_TERM_DAYS_REQUIRES_BANK_TRANSFER_ONLY`.","minimum":0,"maximum":365,"uniqueKey":"refusedResync.oneOf.0.values.paymentTermDays","typeLabel":"integer"},"sessionExpiryMinutes":{"type":"number","description":"Number of minutes until the payment session expires. Defaults to 240 minutes (4 hours) if not provided.","minimum":1,"uniqueKey":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"refusedResync.oneOf.0.values.metadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"refusedResync.oneOf.0.values.metadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"refusedResync.oneOf.0.values.metadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.changeReason","typeLabel":"enum\u003cstring>"},"changeDescription":{"type":"string","maxLength":1000,"description":"A free-text note on why these intervals are changing.","uniqueKey":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.changeMetadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","maxLength":500,"uniqueKey":"refusedResync.oneOf.0.values.changeMetadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","maxLength":500,"uniqueKey":"refusedResync.oneOf.0.values.changeMetadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"refusedResync.oneOf.0.values.changeMetadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.addPrices.items.[INDEX].installments","typeLabel":"integer"},"amounts":{"type":"array","minItems":2,"maxItems":60,"items":{"type":"string","uniqueKey":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.addPrices.items.[INDEX].amounts","typeLabel":"string[]"}},"uniqueKey":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.overridePrices.items.[INDEX].overridesPriceId","typeLabel":"string"},"unitPrice":{"type":"string","description":"The agreed rate, as a decimal string.","uniqueKey":"refusedResync.oneOf.0.values.overridePrices.items.[INDEX].unitPrice","typeLabel":"string"},"baseQuantity":{"type":"string","description":"The agreed quantity, as a decimal string.","uniqueKey":"refusedResync.oneOf.0.values.overridePrices.items.[INDEX].baseQuantity","typeLabel":"string"}},"uniqueKey":"refusedResync.oneOf.0.values.overridePrices.items.[INDEX]","typeLabel":"object"},"description":"Rate or quantity overrides for prices the plan version does carry.","uniqueKey":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.removePrices.items.[INDEX].priceId","typeLabel":"string"}},"uniqueKey":"refusedResync.oneOf.0.values.removePrices.items.[INDEX]","typeLabel":"object"},"description":"Plan prices this subscription does not bill.","uniqueKey":"refusedResync.oneOf.0.values.removePrices","typeLabel":"object[]"},"planVersionId":{"type":"string","description":"A published version of `planId` to pin the proposal to. Only a pinned proposal (`versionPolicy: \"pinned\"`) names a version. One that names none, or `null`, pins the plan's default version, as a change of `planId` without a version does. A floating proposal follows the plan's default version, and one that names a version is refused with 400.","uniqueKey":"refusedResync.oneOf.0.values.planVersionId","typeLabel":"string"},"adjustments":{"type":"array","maxItems":25,"items":{"oneOf":[{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","percentageDiscount","effectiveFrom"],"properties":{"type":{"type":"string","enum":["percentageDiscount"],"description":"Reduces every discountable charge on the invoice by a rate.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"percentageDiscount":{"type":"string","description":"The discount rate as a decimal fraction between 0 and 1, sent as a string. \"0.35\" means 35 percent. \"1\" means 100 percent, not 1 percent. At most 6 decimal places. A value of 0 or above 1 is rejected.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0.percentageDiscount","typeLabel":"string"},"effectiveFrom":{"type":"string","format":"date-time","description":"The first instant the discount applies. Inclusive.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"The instant the discount stops applying. Exclusive, so a window ending on the same date another begins neither overlaps nor leaves a gap. Null means the discount never stops, and it cannot be ended later — set an instant whenever the deal has a known end date. Must be after effectiveFrom.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The instant the discount stops applying. Exclusive, so a window ending on the same date another begins neither overlaps nor leaves a gap. Null means the discount never stops, and it cannot be ended later — set an instant whenever the deal has a known end date. Must be after effectiveFrom.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"The deal's own name, shown on each discount line of the invoice.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The deal's own name, shown on each discount line of the invoice.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second adjustment, and two percentage discounts compound — two of 0.35 bill 57.75 percent off, not 35 percent.","example":"adj_fy26_growth_001","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","usageDiscount","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["usageDiscount"],"description":"Reduces one metered price's billable quantity by a number of usage units, before the line is priced.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"usageDiscount":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The number of usage units to take off the billable quantity, sent as a plain decimal string. \"300\" waives 300 units. Greater than 0, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. Applied in full or not at all — a unit count is never prorated across a partial window — and once per matching line, so an invoice bundling several periods is corrected on each of them. The line is floored at 0, so a discount larger than the billable quantity zeroes it rather than crediting. On a volume ladder the corrected quantity also re-selects the band, so a waiver that crosses a boundary can bill more than the uncorrected line did: waiving 300 of 1000 units on a ladder of 2.00 up to 999 and 1.00 beyond bills 700 at 2.00 for 1400.00, where the 1000 units billed 1000.00. That is the ladder's price for the corrected usage — what a customer who genuinely used 700 units pays — so check the ladder before waiving units near a band boundary.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.usageDiscount","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one metered price of this subscription, priced as standard or volume. Usage units are not comparable across metrics, so a usage discount names the one price it reduces. A dynamic or percentage price is refused: its quantity is a monetary amount rather than a unit count. A price billing at a negative rate (a usage-scaled rebate) is refused too, because removing its units would raise the invoice.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a metered line is corrected when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. Set it to the start of the period you are correcting.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, unlike percentageDiscount: a metered line bills in arrears, so set this to the exact period end you are correcting and that period is covered. Null means the discount never stops — it then takes its full unit count off this price on EVERY later invoice, so set both bounds whenever you are correcting one period. Must be after effectiveFrom.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, unlike percentageDiscount: a metered line bills in arrears, so set this to the exact period end you are correcting and that period is covered. Null means the discount never stops — it then takes its full unit count off this price on EVERY later invoice, so set both bounds whenever you are correcting one period. Must be after effectiveFrom.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this correction. A usageDiscount emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this correction. A usageDiscount emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second adjustment, and usage discounts against one price SUM — two of \"300\" waive 600 units, not 300. Nothing else detects a duplicate.","example":"adj_mar_outage_001","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","minimumQuantity","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["minimumQuantity"],"description":"Bills at least the contracted quantity on one price, whatever the customer actually used.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"minimumQuantity":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The contracted minimum quantity for one billing period of the target price, sent as a plain decimal string. Not negative, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. \"4\" bills 4 seats in a period the customer used 2 in; a value of 0 binds nothing. Measured over the whole billing period, not per line: where a period is split into several lines, each line's quantity counts for its share of the period, and every line is scaled by the same factor to bring the period to the minimum. Several bounds of the same direction on one price do not add up — the greatest minimum and the least maximum are the ones that apply.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.minimumQuantity","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one price of this subscription. A metered price is accepted, and so is a price whose supply is outside the scope of VAT: a bound constrains a measurement rather than an amount of consideration. A price that bills once rather than per period is refused, because there is no repeating period for the bound to be measured over.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a line is bounded when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. The bound is never prorated — a window opening mid-period applies to that whole period.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second bound; two identical bounds change nothing, because bounds of one direction do not add up.","example":"adj_fortress_seats_001","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","maximumQuantity","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["maximumQuantity"],"description":"Bills at most the contracted quantity on one price, whatever the customer actually used.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"maximumQuantity":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The contracted maximum quantity for one billing period of the target price, sent as a plain decimal string. Not negative, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. \"4\" bills 4 seats in a period the customer used 9 in; a value of 0 bills nothing at all. Measured over the whole billing period, not per line: where a period is split into several lines, each line's quantity counts for its share of the period, and every line is scaled by the same factor to bring the period to the maximum. Several bounds of the same direction on one price do not add up — the greatest minimum and the least maximum are the ones that apply.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.maximumQuantity","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one price of this subscription. A metered price is accepted, and so is a price whose supply is outside the scope of VAT: a bound constrains a measurement rather than an amount of consideration. A price that bills once rather than per period is refused, because there is no repeating period for the bound to be measured over.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a line is bounded when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. The bound is never prorated — a window opening mid-period applies to that whole period.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second bound; two identical bounds change nothing, because bounds of one direction do not add up.","example":"adj_fortress_seats_001","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX]","typeLabel":"object"},"description":"Adjustments the subscription gets when the proposal is approved. Each is checked as subscription adjustment create checks it, against the prices the proposal bills and the other adjustments in this list.","uniqueKey":"refusedResync.oneOf.0.values.adjustments","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values","typeLabel":"object"},"credentialId":{"oneOf":[{"type":"string","description":"The key or OAuth client that sent them; null for a session.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.credentialId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The key or OAuth client that sent them; null for a session.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.credentialId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"refusedResync.oneOf.0.credentialId","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"refusedResync.oneOf.0","typeLabel":"object"},{"type":"null","description":"The CRM's latest refused re-sync, or null. It changes `hash`, so a decision made before it arrived answers 409 `SUBSCRIPTION_PROPOSAL_CHANGED`.","isRequired":true,"uniqueKey":"refusedResync.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"refusedResync","typeLabel":"object | null"},"lockVersion":{"type":"integer","description":"Starts at 1, and every change to the proposal adds one.","isRequired":true,"uniqueKey":"lockVersion","typeLabel":"integer"},"source":{"type":"string","description":"The `provider` of the proposal's external reference, or `api` when it has none.","isRequired":true,"uniqueKey":"source","typeLabel":"string"},"externalReference":{"oneOf":[{"type":"object","description":"The record the proposal comes from. Null when it was created without one.","required":["provider","externalId"],"properties":{"provider":{"type":"string","pattern":"^[a-z][a-z0-9_]*$","maxLength":64,"description":"Lowercase snake_case provider identifier (e.g. `salesforce`, `netsuite`)","isRequired":true,"uniqueKey":"externalReference.oneOf.0.provider","typeLabel":"string"},"externalId":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","maxLength":255,"description":"Optional external identifier for cross-referencing with external systems. Alphanumeric characters, hyphens, and underscores only.","isRequired":true,"uniqueKey":"externalReference.oneOf.0.externalId","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"externalReference.oneOf.0","typeLabel":"object"},{"type":"null","description":"The record the proposal comes from. Null when it was created without one.","isRequired":true,"uniqueKey":"externalReference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"externalReference","typeLabel":"object | null"},"subscriptionId":{"oneOf":[{"type":"string","description":"The subscription approve created.","isRequired":true,"uniqueKey":"subscriptionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The subscription approve created.","isRequired":true,"uniqueKey":"subscriptionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"subscriptionId","typeLabel":"string | null"},"rejectionReason":{"oneOf":[{"type":"string","description":"Why the proposal was rejected. Null unless it is `rejected`.","enum":["price_mismatch","wrong_plan","wrong_start_date","wrong_customer","duplicate","other"],"x-speakeasy-unknown-values":"allow","isRequired":true,"uniqueKey":"rejectionReason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Why the proposal was rejected. Null unless it is `rejected`.","isRequired":true,"uniqueKey":"rejectionReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rejectionReason","typeLabel":"enum\u003cstring> | null"},"rejectionText":{"oneOf":[{"type":"string","description":"The notes the reviewer gave with the rejection.","isRequired":true,"uniqueKey":"rejectionText.oneOf.0","typeLabel":"string"},{"type":"null","description":"The notes the reviewer gave with the rejection.","isRequired":true,"uniqueKey":"rejectionText.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rejectionText","typeLabel":"string | null"},"decidedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"decidedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"decidedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"decidedAt","typeLabel":"string\u003cdate-time> | null"},"decidedByPrincipalId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"decidedByPrincipalId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"decidedByPrincipalId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"decidedByPrincipalId","typeLabel":"string | null"},"decidedBy":{"oneOf":[{"type":"object","description":"Who approved or rejected the proposal, by name. Null until it is decided, and when the decider cannot be named: a decision made with the platform key, or by a principal that no longer exists.","required":["type","name"],"properties":{"type":{"type":"string","enum":["user","apiKey"],"x-speakeasy-unknown-values":"allow","description":"`user` for a member of the merchant, `apiKey` for an API key. Open set.","isRequired":true,"uniqueKey":"decidedBy.oneOf.0.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"A user's first and last name, or their email when both are blank; an API key's name.","isRequired":true,"uniqueKey":"decidedBy.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"decidedBy.oneOf.0","typeLabel":"object"},{"type":"null","description":"Who approved or rejected the proposal, by name. Null until it is decided, and when the decider cannot be named: a decision made with the platform key, or by a principal that no longer exists.","isRequired":true,"uniqueKey":"decidedBy.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"decidedBy","typeLabel":"object | null"},"strandedAt":{"oneOf":[{"type":"string","format":"date-time","description":"Set when an approve ended with its subscription waiting for its first invoice; a repeated approve resumes it.","isRequired":true,"uniqueKey":"strandedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Set when an approve ended with its subscription waiting for its first invoice; a repeated approve resumes it.","isRequired":true,"uniqueKey":"strandedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"strandedAt","typeLabel":"string\u003cdate-time> | null"},"createdByPrincipalId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"createdByPrincipalId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"createdByPrincipalId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"createdByPrincipalId","typeLabel":"string | null"},"createdByCredentialId":{"oneOf":[{"type":"string","description":"The API key or OAuth client that created the proposal; null for a dashboard session.","isRequired":true,"uniqueKey":"createdByCredentialId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The API key or OAuth client that created the proposal; null for a dashboard session.","isRequired":true,"uniqueKey":"createdByCredentialId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"createdByCredentialId","typeLabel":"string | null"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"revisions":{"type":"array","items":{"type":"object","description":"One set of values the client sent for a proposal. A revision never changes.","required":["id","version","values","createdAt","createdByCredentialId"],"additionalProperties":false,"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"revisions.items.[INDEX].id","typeLabel":"string"},"version":{"type":"integer","minimum":1,"description":"1 for the values the proposal was created with, then one more for each set sent after.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].version","typeLabel":"integer"},"values":{"type":"object","additionalProperties":false,"description":"The values as the client sent them, without `externalReference`.","required":["planId","customerId","name","startedAt"],"properties":{"customerId":{"type":"string","pattern":"^cus_[a-zA-Z0-9]+$","description":"Unique identifier for a customer","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.customerId","typeLabel":"string"},"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":"revisions.items.[INDEX].values.name","typeLabel":"string"},"planId":{"type":"string","pattern":"^plan_[a-zA-Z0-9]+$","description":"Unique identifier for a plan","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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.","uniqueKey":"revisions.items.[INDEX].values.autoCharge","typeLabel":"boolean"},"taxExempt":{"type":"boolean","description":"When true, forces tax rate to 0%. Use for customers with verified tax-exempt status.","uniqueKey":"revisions.items.[INDEX].values.taxExempt","typeLabel":"boolean"},"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":"revisions.items.[INDEX].values.endingAt","typeLabel":"string\u003cdate-time>"},"prefundAmount":{"type":"string","deprecated":true,"description":"Deprecated. This field is ignored and has no effect.","uniqueKey":"revisions.items.[INDEX].values.prefundAmount","typeLabel":"string"},"minimumAccountBalance":{"type":"string","deprecated":true,"description":"Deprecated. This field is ignored and has no effect.","uniqueKey":"revisions.items.[INDEX].values.minimumAccountBalance","typeLabel":"string"},"redirectUrls":{"title":"SubscriptionProposalRedirectUrls","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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.redirectUrls.onFailure","typeLabel":"string\u003curi>"}},"uniqueKey":"revisions.items.[INDEX].values.redirectUrls","typeLabel":"SubscriptionProposalRedirectUrls · object"},"elapsedPeriodBilling":{"type":"string","enum":["none","per_period"],"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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.renewalReminderEnabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.renewalReminderDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"revisions.items.[INDEX].values.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\"). A non-zero value needs `metadata.bankTransferOnly: true`; without it the request answers 400 `PAYMENT_TERM_DAYS_REQUIRES_BANK_TRANSFER_ONLY`.","minimum":0,"maximum":365,"uniqueKey":"revisions.items.[INDEX].values.paymentTermDays","typeLabel":"integer"},"sessionExpiryMinutes":{"type":"number","description":"Number of minutes until the payment session expires. Defaults to 240 minutes (4 hours) if not provided.","minimum":1,"uniqueKey":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"revisions.items.[INDEX].values.metadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"revisions.items.[INDEX].values.metadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"revisions.items.[INDEX].values.metadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.changeReason","typeLabel":"enum\u003cstring>"},"changeDescription":{"type":"string","maxLength":1000,"description":"A free-text note on why these intervals are changing.","uniqueKey":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.changeMetadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","maxLength":500,"uniqueKey":"revisions.items.[INDEX].values.changeMetadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","maxLength":500,"uniqueKey":"revisions.items.[INDEX].values.changeMetadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"revisions.items.[INDEX].values.changeMetadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.addPrices.items.[INDEX].installments","typeLabel":"integer"},"amounts":{"type":"array","minItems":2,"maxItems":60,"items":{"type":"string","uniqueKey":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.addPrices.items.[INDEX].amounts","typeLabel":"string[]"}},"uniqueKey":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.overridePrices.items.[INDEX].overridesPriceId","typeLabel":"string"},"unitPrice":{"type":"string","description":"The agreed rate, as a decimal string.","uniqueKey":"revisions.items.[INDEX].values.overridePrices.items.[INDEX].unitPrice","typeLabel":"string"},"baseQuantity":{"type":"string","description":"The agreed quantity, as a decimal string.","uniqueKey":"revisions.items.[INDEX].values.overridePrices.items.[INDEX].baseQuantity","typeLabel":"string"}},"uniqueKey":"revisions.items.[INDEX].values.overridePrices.items.[INDEX]","typeLabel":"object"},"description":"Rate or quantity overrides for prices the plan version does carry.","uniqueKey":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.removePrices.items.[INDEX].priceId","typeLabel":"string"}},"uniqueKey":"revisions.items.[INDEX].values.removePrices.items.[INDEX]","typeLabel":"object"},"description":"Plan prices this subscription does not bill.","uniqueKey":"revisions.items.[INDEX].values.removePrices","typeLabel":"object[]"},"planVersionId":{"type":"string","description":"A published version of `planId` to pin the proposal to. Only a pinned proposal (`versionPolicy: \"pinned\"`) names a version. One that names none, or `null`, pins the plan's default version, as a change of `planId` without a version does. A floating proposal follows the plan's default version, and one that names a version is refused with 400.","uniqueKey":"revisions.items.[INDEX].values.planVersionId","typeLabel":"string"},"adjustments":{"type":"array","maxItems":25,"items":{"oneOf":[{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","percentageDiscount","effectiveFrom"],"properties":{"type":{"type":"string","enum":["percentageDiscount"],"description":"Reduces every discountable charge on the invoice by a rate.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"percentageDiscount":{"type":"string","description":"The discount rate as a decimal fraction between 0 and 1, sent as a string. \"0.35\" means 35 percent. \"1\" means 100 percent, not 1 percent. At most 6 decimal places. A value of 0 or above 1 is rejected.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0.percentageDiscount","typeLabel":"string"},"effectiveFrom":{"type":"string","format":"date-time","description":"The first instant the discount applies. Inclusive.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"The instant the discount stops applying. Exclusive, so a window ending on the same date another begins neither overlaps nor leaves a gap. Null means the discount never stops, and it cannot be ended later — set an instant whenever the deal has a known end date. Must be after effectiveFrom.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The instant the discount stops applying. Exclusive, so a window ending on the same date another begins neither overlaps nor leaves a gap. Null means the discount never stops, and it cannot be ended later — set an instant whenever the deal has a known end date. Must be after effectiveFrom.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"The deal's own name, shown on each discount line of the invoice.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The deal's own name, shown on each discount line of the invoice.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second adjustment, and two percentage discounts compound — two of 0.35 bill 57.75 percent off, not 35 percent.","example":"adj_fy26_growth_001","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","usageDiscount","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["usageDiscount"],"description":"Reduces one metered price's billable quantity by a number of usage units, before the line is priced.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"usageDiscount":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The number of usage units to take off the billable quantity, sent as a plain decimal string. \"300\" waives 300 units. Greater than 0, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. Applied in full or not at all — a unit count is never prorated across a partial window — and once per matching line, so an invoice bundling several periods is corrected on each of them. The line is floored at 0, so a discount larger than the billable quantity zeroes it rather than crediting. On a volume ladder the corrected quantity also re-selects the band, so a waiver that crosses a boundary can bill more than the uncorrected line did: waiving 300 of 1000 units on a ladder of 2.00 up to 999 and 1.00 beyond bills 700 at 2.00 for 1400.00, where the 1000 units billed 1000.00. That is the ladder's price for the corrected usage — what a customer who genuinely used 700 units pays — so check the ladder before waiving units near a band boundary.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.usageDiscount","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one metered price of this subscription, priced as standard or volume. Usage units are not comparable across metrics, so a usage discount names the one price it reduces. A dynamic or percentage price is refused: its quantity is a monetary amount rather than a unit count. A price billing at a negative rate (a usage-scaled rebate) is refused too, because removing its units would raise the invoice.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a metered line is corrected when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. Set it to the start of the period you are correcting.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, unlike percentageDiscount: a metered line bills in arrears, so set this to the exact period end you are correcting and that period is covered. Null means the discount never stops — it then takes its full unit count off this price on EVERY later invoice, so set both bounds whenever you are correcting one period. Must be after effectiveFrom.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, unlike percentageDiscount: a metered line bills in arrears, so set this to the exact period end you are correcting and that period is covered. Null means the discount never stops — it then takes its full unit count off this price on EVERY later invoice, so set both bounds whenever you are correcting one period. Must be after effectiveFrom.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this correction. A usageDiscount emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this correction. A usageDiscount emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second adjustment, and usage discounts against one price SUM — two of \"300\" waive 600 units, not 300. Nothing else detects a duplicate.","example":"adj_mar_outage_001","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","minimumQuantity","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["minimumQuantity"],"description":"Bills at least the contracted quantity on one price, whatever the customer actually used.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"minimumQuantity":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The contracted minimum quantity for one billing period of the target price, sent as a plain decimal string. Not negative, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. \"4\" bills 4 seats in a period the customer used 2 in; a value of 0 binds nothing. Measured over the whole billing period, not per line: where a period is split into several lines, each line's quantity counts for its share of the period, and every line is scaled by the same factor to bring the period to the minimum. Several bounds of the same direction on one price do not add up — the greatest minimum and the least maximum are the ones that apply.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.minimumQuantity","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one price of this subscription. A metered price is accepted, and so is a price whose supply is outside the scope of VAT: a bound constrains a measurement rather than an amount of consideration. A price that bills once rather than per period is refused, because there is no repeating period for the bound to be measured over.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a line is bounded when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. The bound is never prorated — a window opening mid-period applies to that whole period.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second bound; two identical bounds change nothing, because bounds of one direction do not add up.","example":"adj_fortress_seats_001","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","maximumQuantity","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["maximumQuantity"],"description":"Bills at most the contracted quantity on one price, whatever the customer actually used.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"maximumQuantity":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The contracted maximum quantity for one billing period of the target price, sent as a plain decimal string. Not negative, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. \"4\" bills 4 seats in a period the customer used 9 in; a value of 0 bills nothing at all. Measured over the whole billing period, not per line: where a period is split into several lines, each line's quantity counts for its share of the period, and every line is scaled by the same factor to bring the period to the maximum. Several bounds of the same direction on one price do not add up — the greatest minimum and the least maximum are the ones that apply.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.maximumQuantity","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one price of this subscription. A metered price is accepted, and so is a price whose supply is outside the scope of VAT: a bound constrains a measurement rather than an amount of consideration. A price that bills once rather than per period is refused, because there is no repeating period for the bound to be measured over.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a line is bounded when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. The bound is never prorated — a window opening mid-period applies to that whole period.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second bound; two identical bounds change nothing, because bounds of one direction do not add up.","example":"adj_fortress_seats_001","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX]","typeLabel":"object"},"description":"Adjustments the subscription gets when the proposal is approved. Each is checked as subscription adjustment create checks it, against the prices the proposal bills and the other adjustments in this list.","uniqueKey":"revisions.items.[INDEX].values.adjustments","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"revisions.items.[INDEX].values","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"revisions.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"createdByCredentialId":{"oneOf":[{"type":"string","description":"The API key or OAuth client that sent the values; null for a dashboard session.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].createdByCredentialId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The API key or OAuth client that sent the values; null for a dashboard session.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].createdByCredentialId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"revisions.items.[INDEX].createdByCredentialId","typeLabel":"string | null"}},"uniqueKey":"revisions.items.[INDEX]","typeLabel":"object"},"description":"Each set of values the client sent, earliest first. Present only with `expand=revisions`. The last one is `requested`.","uniqueKey":"revisions","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","object":"subscriptionProposal","merchantId":"\u003cstring>","status":"pending","customerId":"\u003cstring>","planId":"\u003cstring>","planVersionId":"\u003cstring>","resolvedPlanVersionId":"\u003cstring>","hash":"\u003cstring>","testClockId":"\u003cstring>","requested":{"customerId":"\u003cstring>","name":"\u003cstring>","planId":"\u003cstring>","startedAt":"2023-11-07T05:31:56Z","autoCharge":true,"taxExempt":true,"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,"versionPolicy":"floating","metadata":{},"changeReason":"commercial","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>"}],"planVersionId":"\u003cstring>","adjustments":[{"type":"percentageDiscount","percentageDiscount":"\u003cstring>","effectiveFrom":"2023-11-07T05:31:56Z","effectiveTo":"2023-11-07T05:31:56Z","description":"\u003cstring>","idempotencyKey":"adj_fy26_growth_001"}]},"current":{"customerId":"\u003cstring>","name":"\u003cstring>","planId":"\u003cstring>","startedAt":"2023-11-07T05:31:56Z","autoCharge":true,"taxExempt":true,"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,"versionPolicy":"floating","metadata":{},"changeReason":"commercial","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>"}],"planVersionId":"\u003cstring>","adjustments":[{"type":"percentageDiscount","percentageDiscount":"\u003cstring>","effectiveFrom":"2023-11-07T05:31:56Z","effectiveTo":"2023-11-07T05:31:56Z","description":"\u003cstring>","idempotencyKey":"adj_fy26_growth_001"}]},"amendedFields":["\u003cstring>"],"refusedResync":{"receivedAt":"2023-11-07T05:31:56Z","code":"SUBSCRIPTION_PROPOSAL_RESYNC_CONFLICT","fields":["\u003cstring>"],"values":{"customerId":"\u003cstring>","name":"\u003cstring>","planId":"\u003cstring>","startedAt":"2023-11-07T05:31:56Z","autoCharge":true,"taxExempt":true,"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,"versionPolicy":"floating","metadata":{},"changeReason":"commercial","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>"}],"planVersionId":"\u003cstring>","adjustments":[{"type":"percentageDiscount","percentageDiscount":"\u003cstring>","effectiveFrom":"2023-11-07T05:31:56Z","effectiveTo":"2023-11-07T05:31:56Z","description":"\u003cstring>","idempotencyKey":"adj_fy26_growth_001"}]},"credentialId":"\u003cstring>"},"lockVersion":123,"source":"\u003cstring>","externalReference":{"provider":"\u003cstring>","externalId":"\u003cstring>"},"subscriptionId":"\u003cstring>","rejectionReason":"price_mismatch","rejectionText":"\u003cstring>","decidedAt":"2023-11-07T05:31:56Z","decidedByPrincipalId":"\u003cstring>","decidedBy":{"type":"user","name":"\u003cstring>"},"strandedAt":"2023-11-07T05:31:56Z","createdByPrincipalId":"\u003cstring>","createdByCredentialId":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","revisions":[{"id":"\u003cstring>","version":2,"values":{"customerId":"\u003cstring>","name":"\u003cstring>","planId":"\u003cstring>","startedAt":"2023-11-07T05:31:56Z","autoCharge":true,"taxExempt":true,"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,"versionPolicy":"floating","metadata":{},"changeReason":"commercial","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>"}],"planVersionId":"\u003cstring>","adjustments":[{"type":"percentageDiscount","percentageDiscount":"\u003cstring>","effectiveFrom":"2023-11-07T05:31:56Z","effectiveTo":"2023-11-07T05:31:56Z","description":"\u003cstring>","idempotencyKey":"adj_fy26_growth_001"}]},"createdAt":"2023-11-07T05:31:56Z","createdByCredentialId":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"9149c62e-835d-4a34-ae29-0f0466516942":{"description":"Subscription proposal created","content":{"application/json":{"schema":{"type":"object","description":"A subscription a client proposed, held until a person approves or rejects it. No subscription exists until it is approved.","required":["id","object","merchantId","status","customerId","planId","planVersionId","resolvedPlanVersionId","hash","testClockId","requested","current","amendedFields","refusedResync","lockVersion","source","externalReference","subscriptionId","rejectionReason","rejectionText","decidedAt","decidedByPrincipalId","decidedBy","strandedAt","createdByPrincipalId","createdByCredentialId","createdAt","updatedAt"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","enum":["subscriptionProposal"],"isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"merchantId":{"type":"string","pattern":"^org_[a-zA-Z0-9]+$","description":"Unique identifier for an organization","isRequired":true,"uniqueKey":"merchantId","typeLabel":"string"},"status":{"type":"string","enum":["pending","approved","rejected"],"description":"`pending` until a person approves or rejects the proposal.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"customerId":{"type":"string","pattern":"^cus_[a-zA-Z0-9]+$","description":"Unique identifier for a customer","isRequired":true,"uniqueKey":"customerId","typeLabel":"string"},"planId":{"type":"string","pattern":"^plan_[a-zA-Z0-9]+$","description":"Unique identifier for a plan","isRequired":true,"uniqueKey":"planId","typeLabel":"string"},"planVersionId":{"oneOf":[{"type":"string","description":"The plan version a pinned proposal is pinned to. Null for a floating proposal, which follows the plan's default version.","isRequired":true,"uniqueKey":"planVersionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The plan version a pinned proposal is pinned to. Null for a floating proposal, which follows the plan's default version.","isRequired":true,"uniqueKey":"planVersionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"planVersionId","typeLabel":"string | null"},"resolvedPlanVersionId":{"oneOf":[{"type":"string","description":"The plan version approve would use now: `planVersionId` when pinned, else the plan's default version. Null when the plan has no published version.","isRequired":true,"uniqueKey":"resolvedPlanVersionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The plan version approve would use now: `planVersionId` when pinned, else the plan's default version. Null when the plan has no published version.","isRequired":true,"uniqueKey":"resolvedPlanVersionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"resolvedPlanVersionId","typeLabel":"string | null"},"hash":{"type":"string","description":"Changes whenever `current` or `resolvedPlanVersionId` changes. A decision sends it as `basedOnHash`, so a person only decides on the proposal they read.","isRequired":true,"uniqueKey":"hash","typeLabel":"string"},"testClockId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"testClockId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"testClockId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"testClockId","typeLabel":"string | null"},"requested":{"type":"object","additionalProperties":false,"description":"The values as the client last sent them, without `externalReference`.","required":["planId","customerId","name","startedAt"],"properties":{"customerId":{"type":"string","pattern":"^cus_[a-zA-Z0-9]+$","description":"Unique identifier for a customer","isRequired":true,"uniqueKey":"requested.customerId","typeLabel":"string"},"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":"requested.name","typeLabel":"string"},"planId":{"type":"string","pattern":"^plan_[a-zA-Z0-9]+$","description":"Unique identifier for a plan","isRequired":true,"uniqueKey":"requested.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":"requested.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.","uniqueKey":"requested.autoCharge","typeLabel":"boolean"},"taxExempt":{"type":"boolean","description":"When true, forces tax rate to 0%. Use for customers with verified tax-exempt status.","uniqueKey":"requested.taxExempt","typeLabel":"boolean"},"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":"requested.endingAt","typeLabel":"string\u003cdate-time>"},"prefundAmount":{"type":"string","deprecated":true,"description":"Deprecated. This field is ignored and has no effect.","uniqueKey":"requested.prefundAmount","typeLabel":"string"},"minimumAccountBalance":{"type":"string","deprecated":true,"description":"Deprecated. This field is ignored and has no effect.","uniqueKey":"requested.minimumAccountBalance","typeLabel":"string"},"redirectUrls":{"title":"SubscriptionProposalRedirectUrls","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":"requested.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":"requested.redirectUrls.onFailure","typeLabel":"string\u003curi>"}},"uniqueKey":"requested.redirectUrls","typeLabel":"SubscriptionProposalRedirectUrls · object"},"elapsedPeriodBilling":{"type":"string","enum":["none","per_period"],"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":"requested.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":"requested.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":"requested.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":"requested.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":"requested.renewalReminderEnabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"requested.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":"requested.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":"requested.renewalReminderDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"requested.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\"). A non-zero value needs `metadata.bankTransferOnly: true`; without it the request answers 400 `PAYMENT_TERM_DAYS_REQUIRES_BANK_TRANSFER_ONLY`.","minimum":0,"maximum":365,"uniqueKey":"requested.paymentTermDays","typeLabel":"integer"},"sessionExpiryMinutes":{"type":"number","description":"Number of minutes until the payment session expires. Defaults to 240 minutes (4 hours) if not provided.","minimum":1,"uniqueKey":"requested.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":"requested.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":"requested.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"requested.metadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"requested.metadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"requested.metadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"requested.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":"requested.changeReason","typeLabel":"enum\u003cstring>"},"changeDescription":{"type":"string","maxLength":1000,"description":"A free-text note on why these intervals are changing.","uniqueKey":"requested.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":"requested.changeMetadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","maxLength":500,"uniqueKey":"requested.changeMetadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","maxLength":500,"uniqueKey":"requested.changeMetadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"requested.changeMetadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"requested.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":"requested.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":"requested.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":"requested.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":"requested.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":"requested.addPrices.items.[INDEX].installments","typeLabel":"integer"},"amounts":{"type":"array","minItems":2,"maxItems":60,"items":{"type":"string","uniqueKey":"requested.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":"requested.addPrices.items.[INDEX].amounts","typeLabel":"string[]"}},"uniqueKey":"requested.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":"requested.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":"requested.overridePrices.items.[INDEX].overridesPriceId","typeLabel":"string"},"unitPrice":{"type":"string","description":"The agreed rate, as a decimal string.","uniqueKey":"requested.overridePrices.items.[INDEX].unitPrice","typeLabel":"string"},"baseQuantity":{"type":"string","description":"The agreed quantity, as a decimal string.","uniqueKey":"requested.overridePrices.items.[INDEX].baseQuantity","typeLabel":"string"}},"uniqueKey":"requested.overridePrices.items.[INDEX]","typeLabel":"object"},"description":"Rate or quantity overrides for prices the plan version does carry.","uniqueKey":"requested.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":"requested.removePrices.items.[INDEX].priceId","typeLabel":"string"}},"uniqueKey":"requested.removePrices.items.[INDEX]","typeLabel":"object"},"description":"Plan prices this subscription does not bill.","uniqueKey":"requested.removePrices","typeLabel":"object[]"},"planVersionId":{"type":"string","description":"A published version of `planId` to pin the proposal to. Only a pinned proposal (`versionPolicy: \"pinned\"`) names a version. One that names none, or `null`, pins the plan's default version, as a change of `planId` without a version does. A floating proposal follows the plan's default version, and one that names a version is refused with 400.","uniqueKey":"requested.planVersionId","typeLabel":"string"},"adjustments":{"type":"array","maxItems":25,"items":{"oneOf":[{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","percentageDiscount","effectiveFrom"],"properties":{"type":{"type":"string","enum":["percentageDiscount"],"description":"Reduces every discountable charge on the invoice by a rate.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"percentageDiscount":{"type":"string","description":"The discount rate as a decimal fraction between 0 and 1, sent as a string. \"0.35\" means 35 percent. \"1\" means 100 percent, not 1 percent. At most 6 decimal places. A value of 0 or above 1 is rejected.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0.percentageDiscount","typeLabel":"string"},"effectiveFrom":{"type":"string","format":"date-time","description":"The first instant the discount applies. Inclusive.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"The instant the discount stops applying. Exclusive, so a window ending on the same date another begins neither overlaps nor leaves a gap. Null means the discount never stops, and it cannot be ended later — set an instant whenever the deal has a known end date. Must be after effectiveFrom.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The instant the discount stops applying. Exclusive, so a window ending on the same date another begins neither overlaps nor leaves a gap. Null means the discount never stops, and it cannot be ended later — set an instant whenever the deal has a known end date. Must be after effectiveFrom.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"The deal's own name, shown on each discount line of the invoice.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The deal's own name, shown on each discount line of the invoice.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second adjustment, and two percentage discounts compound — two of 0.35 bill 57.75 percent off, not 35 percent.","example":"adj_fy26_growth_001","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","usageDiscount","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["usageDiscount"],"description":"Reduces one metered price's billable quantity by a number of usage units, before the line is priced.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"usageDiscount":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The number of usage units to take off the billable quantity, sent as a plain decimal string. \"300\" waives 300 units. Greater than 0, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. Applied in full or not at all — a unit count is never prorated across a partial window — and once per matching line, so an invoice bundling several periods is corrected on each of them. The line is floored at 0, so a discount larger than the billable quantity zeroes it rather than crediting. On a volume ladder the corrected quantity also re-selects the band, so a waiver that crosses a boundary can bill more than the uncorrected line did: waiving 300 of 1000 units on a ladder of 2.00 up to 999 and 1.00 beyond bills 700 at 2.00 for 1400.00, where the 1000 units billed 1000.00. That is the ladder's price for the corrected usage — what a customer who genuinely used 700 units pays — so check the ladder before waiving units near a band boundary.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.usageDiscount","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one metered price of this subscription, priced as standard or volume. Usage units are not comparable across metrics, so a usage discount names the one price it reduces. A dynamic or percentage price is refused: its quantity is a monetary amount rather than a unit count. A price billing at a negative rate (a usage-scaled rebate) is refused too, because removing its units would raise the invoice.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a metered line is corrected when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. Set it to the start of the period you are correcting.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, unlike percentageDiscount: a metered line bills in arrears, so set this to the exact period end you are correcting and that period is covered. Null means the discount never stops — it then takes its full unit count off this price on EVERY later invoice, so set both bounds whenever you are correcting one period. Must be after effectiveFrom.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, unlike percentageDiscount: a metered line bills in arrears, so set this to the exact period end you are correcting and that period is covered. Null means the discount never stops — it then takes its full unit count off this price on EVERY later invoice, so set both bounds whenever you are correcting one period. Must be after effectiveFrom.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this correction. A usageDiscount emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this correction. A usageDiscount emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second adjustment, and usage discounts against one price SUM — two of \"300\" waive 600 units, not 300. Nothing else detects a duplicate.","example":"adj_mar_outage_001","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","minimumQuantity","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["minimumQuantity"],"description":"Bills at least the contracted quantity on one price, whatever the customer actually used.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"minimumQuantity":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The contracted minimum quantity for one billing period of the target price, sent as a plain decimal string. Not negative, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. \"4\" bills 4 seats in a period the customer used 2 in; a value of 0 binds nothing. Measured over the whole billing period, not per line: where a period is split into several lines, each line's quantity counts for its share of the period, and every line is scaled by the same factor to bring the period to the minimum. Several bounds of the same direction on one price do not add up — the greatest minimum and the least maximum are the ones that apply.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.minimumQuantity","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one price of this subscription. A metered price is accepted, and so is a price whose supply is outside the scope of VAT: a bound constrains a measurement rather than an amount of consideration. A price that bills once rather than per period is refused, because there is no repeating period for the bound to be measured over.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a line is bounded when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. The bound is never prorated — a window opening mid-period applies to that whole period.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second bound; two identical bounds change nothing, because bounds of one direction do not add up.","example":"adj_fortress_seats_001","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","maximumQuantity","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["maximumQuantity"],"description":"Bills at most the contracted quantity on one price, whatever the customer actually used.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"maximumQuantity":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The contracted maximum quantity for one billing period of the target price, sent as a plain decimal string. Not negative, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. \"4\" bills 4 seats in a period the customer used 9 in; a value of 0 bills nothing at all. Measured over the whole billing period, not per line: where a period is split into several lines, each line's quantity counts for its share of the period, and every line is scaled by the same factor to bring the period to the maximum. Several bounds of the same direction on one price do not add up — the greatest minimum and the least maximum are the ones that apply.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.maximumQuantity","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one price of this subscription. A metered price is accepted, and so is a price whose supply is outside the scope of VAT: a bound constrains a measurement rather than an amount of consideration. A price that bills once rather than per period is refused, because there is no repeating period for the bound to be measured over.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a line is bounded when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. The bound is never prorated — a window opening mid-period applies to that whole period.","isRequired":true,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second bound; two identical bounds change nothing, because bounds of one direction do not add up.","example":"adj_fortress_seats_001","uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"requested.adjustments.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"requested.adjustments.items.[INDEX]","typeLabel":"object"},"description":"Adjustments the subscription gets when the proposal is approved. Each is checked as subscription adjustment create checks it, against the prices the proposal bills and the other adjustments in this list.","uniqueKey":"requested.adjustments","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"requested","typeLabel":"object"},"current":{"type":"object","additionalProperties":false,"description":"The values as they are now, amendments included, with `planVersionId` when the proposal is pinned. Approve creates the subscription from them.","required":["planId","customerId","name","startedAt"],"properties":{"customerId":{"type":"string","pattern":"^cus_[a-zA-Z0-9]+$","description":"Unique identifier for a customer","isRequired":true,"uniqueKey":"current.customerId","typeLabel":"string"},"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":"current.name","typeLabel":"string"},"planId":{"type":"string","pattern":"^plan_[a-zA-Z0-9]+$","description":"Unique identifier for a plan","isRequired":true,"uniqueKey":"current.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":"current.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.","uniqueKey":"current.autoCharge","typeLabel":"boolean"},"taxExempt":{"type":"boolean","description":"When true, forces tax rate to 0%. Use for customers with verified tax-exempt status.","uniqueKey":"current.taxExempt","typeLabel":"boolean"},"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":"current.endingAt","typeLabel":"string\u003cdate-time>"},"prefundAmount":{"type":"string","deprecated":true,"description":"Deprecated. This field is ignored and has no effect.","uniqueKey":"current.prefundAmount","typeLabel":"string"},"minimumAccountBalance":{"type":"string","deprecated":true,"description":"Deprecated. This field is ignored and has no effect.","uniqueKey":"current.minimumAccountBalance","typeLabel":"string"},"redirectUrls":{"title":"SubscriptionProposalRedirectUrls","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":"current.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":"current.redirectUrls.onFailure","typeLabel":"string\u003curi>"}},"uniqueKey":"current.redirectUrls","typeLabel":"SubscriptionProposalRedirectUrls · object"},"elapsedPeriodBilling":{"type":"string","enum":["none","per_period"],"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":"current.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":"current.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":"current.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":"current.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":"current.renewalReminderEnabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"current.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":"current.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":"current.renewalReminderDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"current.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\"). A non-zero value needs `metadata.bankTransferOnly: true`; without it the request answers 400 `PAYMENT_TERM_DAYS_REQUIRES_BANK_TRANSFER_ONLY`.","minimum":0,"maximum":365,"uniqueKey":"current.paymentTermDays","typeLabel":"integer"},"sessionExpiryMinutes":{"type":"number","description":"Number of minutes until the payment session expires. Defaults to 240 minutes (4 hours) if not provided.","minimum":1,"uniqueKey":"current.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":"current.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":"current.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"current.metadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"current.metadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"current.metadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"current.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":"current.changeReason","typeLabel":"enum\u003cstring>"},"changeDescription":{"type":"string","maxLength":1000,"description":"A free-text note on why these intervals are changing.","uniqueKey":"current.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":"current.changeMetadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","maxLength":500,"uniqueKey":"current.changeMetadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","maxLength":500,"uniqueKey":"current.changeMetadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"current.changeMetadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"current.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":"current.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":"current.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":"current.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":"current.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":"current.addPrices.items.[INDEX].installments","typeLabel":"integer"},"amounts":{"type":"array","minItems":2,"maxItems":60,"items":{"type":"string","uniqueKey":"current.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":"current.addPrices.items.[INDEX].amounts","typeLabel":"string[]"}},"uniqueKey":"current.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":"current.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":"current.overridePrices.items.[INDEX].overridesPriceId","typeLabel":"string"},"unitPrice":{"type":"string","description":"The agreed rate, as a decimal string.","uniqueKey":"current.overridePrices.items.[INDEX].unitPrice","typeLabel":"string"},"baseQuantity":{"type":"string","description":"The agreed quantity, as a decimal string.","uniqueKey":"current.overridePrices.items.[INDEX].baseQuantity","typeLabel":"string"}},"uniqueKey":"current.overridePrices.items.[INDEX]","typeLabel":"object"},"description":"Rate or quantity overrides for prices the plan version does carry.","uniqueKey":"current.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":"current.removePrices.items.[INDEX].priceId","typeLabel":"string"}},"uniqueKey":"current.removePrices.items.[INDEX]","typeLabel":"object"},"description":"Plan prices this subscription does not bill.","uniqueKey":"current.removePrices","typeLabel":"object[]"},"planVersionId":{"type":"string","description":"A published version of `planId` to pin the proposal to. Only a pinned proposal (`versionPolicy: \"pinned\"`) names a version. One that names none, or `null`, pins the plan's default version, as a change of `planId` without a version does. A floating proposal follows the plan's default version, and one that names a version is refused with 400.","uniqueKey":"current.planVersionId","typeLabel":"string"},"adjustments":{"type":"array","maxItems":25,"items":{"oneOf":[{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","percentageDiscount","effectiveFrom"],"properties":{"type":{"type":"string","enum":["percentageDiscount"],"description":"Reduces every discountable charge on the invoice by a rate.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"percentageDiscount":{"type":"string","description":"The discount rate as a decimal fraction between 0 and 1, sent as a string. \"0.35\" means 35 percent. \"1\" means 100 percent, not 1 percent. At most 6 decimal places. A value of 0 or above 1 is rejected.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.0.percentageDiscount","typeLabel":"string"},"effectiveFrom":{"type":"string","format":"date-time","description":"The first instant the discount applies. Inclusive.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.0.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"The instant the discount stops applying. Exclusive, so a window ending on the same date another begins neither overlaps nor leaves a gap. Null means the discount never stops, and it cannot be ended later — set an instant whenever the deal has a known end date. Must be after effectiveFrom.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.0.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The instant the discount stops applying. Exclusive, so a window ending on the same date another begins neither overlaps nor leaves a gap. Null means the discount never stops, and it cannot be ended later — set an instant whenever the deal has a known end date. Must be after effectiveFrom.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.0.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"current.adjustments.items.[INDEX].oneOf.0.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"The deal's own name, shown on each discount line of the invoice.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The deal's own name, shown on each discount line of the invoice.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"current.adjustments.items.[INDEX].oneOf.0.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second adjustment, and two percentage discounts compound — two of 0.35 bill 57.75 percent off, not 35 percent.","example":"adj_fy26_growth_001","uniqueKey":"current.adjustments.items.[INDEX].oneOf.0.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","usageDiscount","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["usageDiscount"],"description":"Reduces one metered price's billable quantity by a number of usage units, before the line is priced.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"usageDiscount":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The number of usage units to take off the billable quantity, sent as a plain decimal string. \"300\" waives 300 units. Greater than 0, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. Applied in full or not at all — a unit count is never prorated across a partial window — and once per matching line, so an invoice bundling several periods is corrected on each of them. The line is floored at 0, so a discount larger than the billable quantity zeroes it rather than crediting. On a volume ladder the corrected quantity also re-selects the band, so a waiver that crosses a boundary can bill more than the uncorrected line did: waiving 300 of 1000 units on a ladder of 2.00 up to 999 and 1.00 beyond bills 700 at 2.00 for 1400.00, where the 1000 units billed 1000.00. That is the ladder's price for the corrected usage — what a customer who genuinely used 700 units pays — so check the ladder before waiving units near a band boundary.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.usageDiscount","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one metered price of this subscription, priced as standard or volume. Usage units are not comparable across metrics, so a usage discount names the one price it reduces. A dynamic or percentage price is refused: its quantity is a monetary amount rather than a unit count. A price billing at a negative rate (a usage-scaled rebate) is refused too, because removing its units would raise the invoice.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a metered line is corrected when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. Set it to the start of the period you are correcting.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, unlike percentageDiscount: a metered line bills in arrears, so set this to the exact period end you are correcting and that period is covered. Null means the discount never stops — it then takes its full unit count off this price on EVERY later invoice, so set both bounds whenever you are correcting one period. Must be after effectiveFrom.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, unlike percentageDiscount: a metered line bills in arrears, so set this to the exact period end you are correcting and that period is covered. Null means the discount never stops — it then takes its full unit count off this price on EVERY later invoice, so set both bounds whenever you are correcting one period. Must be after effectiveFrom.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this correction. A usageDiscount emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this correction. A usageDiscount emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second adjustment, and usage discounts against one price SUM — two of \"300\" waive 600 units, not 300. Nothing else detects a duplicate.","example":"adj_mar_outage_001","uniqueKey":"current.adjustments.items.[INDEX].oneOf.1.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","minimumQuantity","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["minimumQuantity"],"description":"Bills at least the contracted quantity on one price, whatever the customer actually used.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"minimumQuantity":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The contracted minimum quantity for one billing period of the target price, sent as a plain decimal string. Not negative, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. \"4\" bills 4 seats in a period the customer used 2 in; a value of 0 binds nothing. Measured over the whole billing period, not per line: where a period is split into several lines, each line's quantity counts for its share of the period, and every line is scaled by the same factor to bring the period to the minimum. Several bounds of the same direction on one price do not add up — the greatest minimum and the least maximum are the ones that apply.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.minimumQuantity","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one price of this subscription. A metered price is accepted, and so is a price whose supply is outside the scope of VAT: a bound constrains a measurement rather than an amount of consideration. A price that bills once rather than per period is refused, because there is no repeating period for the bound to be measured over.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a line is bounded when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. The bound is never prorated — a window opening mid-period applies to that whole period.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second bound; two identical bounds change nothing, because bounds of one direction do not add up.","example":"adj_fortress_seats_001","uniqueKey":"current.adjustments.items.[INDEX].oneOf.2.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","maximumQuantity","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["maximumQuantity"],"description":"Bills at most the contracted quantity on one price, whatever the customer actually used.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"maximumQuantity":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The contracted maximum quantity for one billing period of the target price, sent as a plain decimal string. Not negative, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. \"4\" bills 4 seats in a period the customer used 9 in; a value of 0 bills nothing at all. Measured over the whole billing period, not per line: where a period is split into several lines, each line's quantity counts for its share of the period, and every line is scaled by the same factor to bring the period to the maximum. Several bounds of the same direction on one price do not add up — the greatest minimum and the least maximum are the ones that apply.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.maximumQuantity","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one price of this subscription. A metered price is accepted, and so is a price whose supply is outside the scope of VAT: a bound constrains a measurement rather than an amount of consideration. A price that bills once rather than per period is refused, because there is no repeating period for the bound to be measured over.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a line is bounded when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. The bound is never prorated — a window opening mid-period applies to that whole period.","isRequired":true,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second bound; two identical bounds change nothing, because bounds of one direction do not add up.","example":"adj_fortress_seats_001","uniqueKey":"current.adjustments.items.[INDEX].oneOf.3.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"current.adjustments.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"current.adjustments.items.[INDEX]","typeLabel":"object"},"description":"Adjustments the subscription gets when the proposal is approved. Each is checked as subscription adjustment create checks it, against the prices the proposal bills and the other adjustments in this list.","uniqueKey":"current.adjustments","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"current","typeLabel":"object"},"amendedFields":{"type":"array","items":{"type":"string","uniqueKey":"amendedFields.items.[INDEX]","typeLabel":"string"},"description":"The top-level fields a person amended. A re-send of the external reference keeps the person's value for each; a field stays amended when the client sends the person's value.","isRequired":true,"uniqueKey":"amendedFields","typeLabel":"string[]"},"refusedResync":{"oneOf":[{"type":"object","description":"The CRM's latest refused re-sync, or null. It changes `hash`, so a decision made before it arrived answers 409 `SUBSCRIPTION_PROPOSAL_CHANGED`.","required":["receivedAt","code","fields","values","credentialId"],"properties":{"receivedAt":{"type":"string","format":"date-time","description":"When the refused values arrived.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.receivedAt","typeLabel":"string\u003cdate-time>"},"code":{"type":"string","enum":["SUBSCRIPTION_PROPOSAL_RESYNC_CONFLICT","SUBSCRIPTION_PROPOSAL_ALREADY_APPROVED"],"description":"The code of the 409 the send answered.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.code","typeLabel":"enum\u003cstring>"},"fields":{"type":"array","items":{"type":"string","uniqueKey":"refusedResync.oneOf.0.fields.items.[INDEX]","typeLabel":"string"},"description":"The fields that conflict with an amendment, or on an approved proposal the fields the CRM changed.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.fields","typeLabel":"string[]"},"values":{"type":"object","additionalProperties":false,"description":"The values the CRM sent, without `externalReference`.","required":["planId","customerId","name","startedAt"],"properties":{"customerId":{"type":"string","pattern":"^cus_[a-zA-Z0-9]+$","description":"Unique identifier for a customer","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.customerId","typeLabel":"string"},"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":"refusedResync.oneOf.0.values.name","typeLabel":"string"},"planId":{"type":"string","pattern":"^plan_[a-zA-Z0-9]+$","description":"Unique identifier for a plan","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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.","uniqueKey":"refusedResync.oneOf.0.values.autoCharge","typeLabel":"boolean"},"taxExempt":{"type":"boolean","description":"When true, forces tax rate to 0%. Use for customers with verified tax-exempt status.","uniqueKey":"refusedResync.oneOf.0.values.taxExempt","typeLabel":"boolean"},"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":"refusedResync.oneOf.0.values.endingAt","typeLabel":"string\u003cdate-time>"},"prefundAmount":{"type":"string","deprecated":true,"description":"Deprecated. This field is ignored and has no effect.","uniqueKey":"refusedResync.oneOf.0.values.prefundAmount","typeLabel":"string"},"minimumAccountBalance":{"type":"string","deprecated":true,"description":"Deprecated. This field is ignored and has no effect.","uniqueKey":"refusedResync.oneOf.0.values.minimumAccountBalance","typeLabel":"string"},"redirectUrls":{"title":"SubscriptionProposalRedirectUrls","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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.redirectUrls.onFailure","typeLabel":"string\u003curi>"}},"uniqueKey":"refusedResync.oneOf.0.values.redirectUrls","typeLabel":"SubscriptionProposalRedirectUrls · object"},"elapsedPeriodBilling":{"type":"string","enum":["none","per_period"],"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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.renewalReminderEnabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.renewalReminderDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"refusedResync.oneOf.0.values.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\"). A non-zero value needs `metadata.bankTransferOnly: true`; without it the request answers 400 `PAYMENT_TERM_DAYS_REQUIRES_BANK_TRANSFER_ONLY`.","minimum":0,"maximum":365,"uniqueKey":"refusedResync.oneOf.0.values.paymentTermDays","typeLabel":"integer"},"sessionExpiryMinutes":{"type":"number","description":"Number of minutes until the payment session expires. Defaults to 240 minutes (4 hours) if not provided.","minimum":1,"uniqueKey":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"refusedResync.oneOf.0.values.metadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"refusedResync.oneOf.0.values.metadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"refusedResync.oneOf.0.values.metadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.changeReason","typeLabel":"enum\u003cstring>"},"changeDescription":{"type":"string","maxLength":1000,"description":"A free-text note on why these intervals are changing.","uniqueKey":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.changeMetadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","maxLength":500,"uniqueKey":"refusedResync.oneOf.0.values.changeMetadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","maxLength":500,"uniqueKey":"refusedResync.oneOf.0.values.changeMetadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"refusedResync.oneOf.0.values.changeMetadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.addPrices.items.[INDEX].installments","typeLabel":"integer"},"amounts":{"type":"array","minItems":2,"maxItems":60,"items":{"type":"string","uniqueKey":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.addPrices.items.[INDEX].amounts","typeLabel":"string[]"}},"uniqueKey":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.overridePrices.items.[INDEX].overridesPriceId","typeLabel":"string"},"unitPrice":{"type":"string","description":"The agreed rate, as a decimal string.","uniqueKey":"refusedResync.oneOf.0.values.overridePrices.items.[INDEX].unitPrice","typeLabel":"string"},"baseQuantity":{"type":"string","description":"The agreed quantity, as a decimal string.","uniqueKey":"refusedResync.oneOf.0.values.overridePrices.items.[INDEX].baseQuantity","typeLabel":"string"}},"uniqueKey":"refusedResync.oneOf.0.values.overridePrices.items.[INDEX]","typeLabel":"object"},"description":"Rate or quantity overrides for prices the plan version does carry.","uniqueKey":"refusedResync.oneOf.0.values.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":"refusedResync.oneOf.0.values.removePrices.items.[INDEX].priceId","typeLabel":"string"}},"uniqueKey":"refusedResync.oneOf.0.values.removePrices.items.[INDEX]","typeLabel":"object"},"description":"Plan prices this subscription does not bill.","uniqueKey":"refusedResync.oneOf.0.values.removePrices","typeLabel":"object[]"},"planVersionId":{"type":"string","description":"A published version of `planId` to pin the proposal to. Only a pinned proposal (`versionPolicy: \"pinned\"`) names a version. One that names none, or `null`, pins the plan's default version, as a change of `planId` without a version does. A floating proposal follows the plan's default version, and one that names a version is refused with 400.","uniqueKey":"refusedResync.oneOf.0.values.planVersionId","typeLabel":"string"},"adjustments":{"type":"array","maxItems":25,"items":{"oneOf":[{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","percentageDiscount","effectiveFrom"],"properties":{"type":{"type":"string","enum":["percentageDiscount"],"description":"Reduces every discountable charge on the invoice by a rate.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"percentageDiscount":{"type":"string","description":"The discount rate as a decimal fraction between 0 and 1, sent as a string. \"0.35\" means 35 percent. \"1\" means 100 percent, not 1 percent. At most 6 decimal places. A value of 0 or above 1 is rejected.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0.percentageDiscount","typeLabel":"string"},"effectiveFrom":{"type":"string","format":"date-time","description":"The first instant the discount applies. Inclusive.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"The instant the discount stops applying. Exclusive, so a window ending on the same date another begins neither overlaps nor leaves a gap. Null means the discount never stops, and it cannot be ended later — set an instant whenever the deal has a known end date. Must be after effectiveFrom.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The instant the discount stops applying. Exclusive, so a window ending on the same date another begins neither overlaps nor leaves a gap. Null means the discount never stops, and it cannot be ended later — set an instant whenever the deal has a known end date. Must be after effectiveFrom.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"The deal's own name, shown on each discount line of the invoice.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The deal's own name, shown on each discount line of the invoice.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second adjustment, and two percentage discounts compound — two of 0.35 bill 57.75 percent off, not 35 percent.","example":"adj_fy26_growth_001","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","usageDiscount","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["usageDiscount"],"description":"Reduces one metered price's billable quantity by a number of usage units, before the line is priced.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"usageDiscount":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The number of usage units to take off the billable quantity, sent as a plain decimal string. \"300\" waives 300 units. Greater than 0, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. Applied in full or not at all — a unit count is never prorated across a partial window — and once per matching line, so an invoice bundling several periods is corrected on each of them. The line is floored at 0, so a discount larger than the billable quantity zeroes it rather than crediting. On a volume ladder the corrected quantity also re-selects the band, so a waiver that crosses a boundary can bill more than the uncorrected line did: waiving 300 of 1000 units on a ladder of 2.00 up to 999 and 1.00 beyond bills 700 at 2.00 for 1400.00, where the 1000 units billed 1000.00. That is the ladder's price for the corrected usage — what a customer who genuinely used 700 units pays — so check the ladder before waiving units near a band boundary.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.usageDiscount","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one metered price of this subscription, priced as standard or volume. Usage units are not comparable across metrics, so a usage discount names the one price it reduces. A dynamic or percentage price is refused: its quantity is a monetary amount rather than a unit count. A price billing at a negative rate (a usage-scaled rebate) is refused too, because removing its units would raise the invoice.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a metered line is corrected when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. Set it to the start of the period you are correcting.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, unlike percentageDiscount: a metered line bills in arrears, so set this to the exact period end you are correcting and that period is covered. Null means the discount never stops — it then takes its full unit count off this price on EVERY later invoice, so set both bounds whenever you are correcting one period. Must be after effectiveFrom.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, unlike percentageDiscount: a metered line bills in arrears, so set this to the exact period end you are correcting and that period is covered. Null means the discount never stops — it then takes its full unit count off this price on EVERY later invoice, so set both bounds whenever you are correcting one period. Must be after effectiveFrom.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this correction. A usageDiscount emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this correction. A usageDiscount emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second adjustment, and usage discounts against one price SUM — two of \"300\" waive 600 units, not 300. Nothing else detects a duplicate.","example":"adj_mar_outage_001","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","minimumQuantity","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["minimumQuantity"],"description":"Bills at least the contracted quantity on one price, whatever the customer actually used.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"minimumQuantity":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The contracted minimum quantity for one billing period of the target price, sent as a plain decimal string. Not negative, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. \"4\" bills 4 seats in a period the customer used 2 in; a value of 0 binds nothing. Measured over the whole billing period, not per line: where a period is split into several lines, each line's quantity counts for its share of the period, and every line is scaled by the same factor to bring the period to the minimum. Several bounds of the same direction on one price do not add up — the greatest minimum and the least maximum are the ones that apply.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.minimumQuantity","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one price of this subscription. A metered price is accepted, and so is a price whose supply is outside the scope of VAT: a bound constrains a measurement rather than an amount of consideration. A price that bills once rather than per period is refused, because there is no repeating period for the bound to be measured over.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a line is bounded when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. The bound is never prorated — a window opening mid-period applies to that whole period.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second bound; two identical bounds change nothing, because bounds of one direction do not add up.","example":"adj_fortress_seats_001","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","maximumQuantity","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["maximumQuantity"],"description":"Bills at most the contracted quantity on one price, whatever the customer actually used.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"maximumQuantity":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The contracted maximum quantity for one billing period of the target price, sent as a plain decimal string. Not negative, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. \"4\" bills 4 seats in a period the customer used 9 in; a value of 0 bills nothing at all. Measured over the whole billing period, not per line: where a period is split into several lines, each line's quantity counts for its share of the period, and every line is scaled by the same factor to bring the period to the maximum. Several bounds of the same direction on one price do not add up — the greatest minimum and the least maximum are the ones that apply.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.maximumQuantity","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one price of this subscription. A metered price is accepted, and so is a price whose supply is outside the scope of VAT: a bound constrains a measurement rather than an amount of consideration. A price that bills once rather than per period is refused, because there is no repeating period for the bound to be measured over.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a line is bounded when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. The bound is never prorated — a window opening mid-period applies to that whole period.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second bound; two identical bounds change nothing, because bounds of one direction do not add up.","example":"adj_fortress_seats_001","uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"refusedResync.oneOf.0.values.adjustments.items.[INDEX]","typeLabel":"object"},"description":"Adjustments the subscription gets when the proposal is approved. Each is checked as subscription adjustment create checks it, against the prices the proposal bills and the other adjustments in this list.","uniqueKey":"refusedResync.oneOf.0.values.adjustments","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"refusedResync.oneOf.0.values","typeLabel":"object"},"credentialId":{"oneOf":[{"type":"string","description":"The key or OAuth client that sent them; null for a session.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.credentialId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The key or OAuth client that sent them; null for a session.","isRequired":true,"uniqueKey":"refusedResync.oneOf.0.credentialId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"refusedResync.oneOf.0.credentialId","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"refusedResync.oneOf.0","typeLabel":"object"},{"type":"null","description":"The CRM's latest refused re-sync, or null. It changes `hash`, so a decision made before it arrived answers 409 `SUBSCRIPTION_PROPOSAL_CHANGED`.","isRequired":true,"uniqueKey":"refusedResync.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"refusedResync","typeLabel":"object | null"},"lockVersion":{"type":"integer","description":"Starts at 1, and every change to the proposal adds one.","isRequired":true,"uniqueKey":"lockVersion","typeLabel":"integer"},"source":{"type":"string","description":"The `provider` of the proposal's external reference, or `api` when it has none.","isRequired":true,"uniqueKey":"source","typeLabel":"string"},"externalReference":{"oneOf":[{"type":"object","description":"The record the proposal comes from. Null when it was created without one.","required":["provider","externalId"],"properties":{"provider":{"type":"string","pattern":"^[a-z][a-z0-9_]*$","maxLength":64,"description":"Lowercase snake_case provider identifier (e.g. `salesforce`, `netsuite`)","isRequired":true,"uniqueKey":"externalReference.oneOf.0.provider","typeLabel":"string"},"externalId":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","maxLength":255,"description":"Optional external identifier for cross-referencing with external systems. Alphanumeric characters, hyphens, and underscores only.","isRequired":true,"uniqueKey":"externalReference.oneOf.0.externalId","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"externalReference.oneOf.0","typeLabel":"object"},{"type":"null","description":"The record the proposal comes from. Null when it was created without one.","isRequired":true,"uniqueKey":"externalReference.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"externalReference","typeLabel":"object | null"},"subscriptionId":{"oneOf":[{"type":"string","description":"The subscription approve created.","isRequired":true,"uniqueKey":"subscriptionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The subscription approve created.","isRequired":true,"uniqueKey":"subscriptionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"subscriptionId","typeLabel":"string | null"},"rejectionReason":{"oneOf":[{"type":"string","description":"Why the proposal was rejected. Null unless it is `rejected`.","enum":["price_mismatch","wrong_plan","wrong_start_date","wrong_customer","duplicate","other"],"x-speakeasy-unknown-values":"allow","isRequired":true,"uniqueKey":"rejectionReason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Why the proposal was rejected. Null unless it is `rejected`.","isRequired":true,"uniqueKey":"rejectionReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rejectionReason","typeLabel":"enum\u003cstring> | null"},"rejectionText":{"oneOf":[{"type":"string","description":"The notes the reviewer gave with the rejection.","isRequired":true,"uniqueKey":"rejectionText.oneOf.0","typeLabel":"string"},{"type":"null","description":"The notes the reviewer gave with the rejection.","isRequired":true,"uniqueKey":"rejectionText.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"rejectionText","typeLabel":"string | null"},"decidedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"decidedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"decidedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"decidedAt","typeLabel":"string\u003cdate-time> | null"},"decidedByPrincipalId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"decidedByPrincipalId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"decidedByPrincipalId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"decidedByPrincipalId","typeLabel":"string | null"},"decidedBy":{"oneOf":[{"type":"object","description":"Who approved or rejected the proposal, by name. Null until it is decided, and when the decider cannot be named: a decision made with the platform key, or by a principal that no longer exists.","required":["type","name"],"properties":{"type":{"type":"string","enum":["user","apiKey"],"x-speakeasy-unknown-values":"allow","description":"`user` for a member of the merchant, `apiKey` for an API key. Open set.","isRequired":true,"uniqueKey":"decidedBy.oneOf.0.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"A user's first and last name, or their email when both are blank; an API key's name.","isRequired":true,"uniqueKey":"decidedBy.oneOf.0.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"decidedBy.oneOf.0","typeLabel":"object"},{"type":"null","description":"Who approved or rejected the proposal, by name. Null until it is decided, and when the decider cannot be named: a decision made with the platform key, or by a principal that no longer exists.","isRequired":true,"uniqueKey":"decidedBy.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"decidedBy","typeLabel":"object | null"},"strandedAt":{"oneOf":[{"type":"string","format":"date-time","description":"Set when an approve ended with its subscription waiting for its first invoice; a repeated approve resumes it.","isRequired":true,"uniqueKey":"strandedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Set when an approve ended with its subscription waiting for its first invoice; a repeated approve resumes it.","isRequired":true,"uniqueKey":"strandedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"strandedAt","typeLabel":"string\u003cdate-time> | null"},"createdByPrincipalId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"createdByPrincipalId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"createdByPrincipalId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"createdByPrincipalId","typeLabel":"string | null"},"createdByCredentialId":{"oneOf":[{"type":"string","description":"The API key or OAuth client that created the proposal; null for a dashboard session.","isRequired":true,"uniqueKey":"createdByCredentialId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The API key or OAuth client that created the proposal; null for a dashboard session.","isRequired":true,"uniqueKey":"createdByCredentialId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"createdByCredentialId","typeLabel":"string | null"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"revisions":{"type":"array","items":{"type":"object","description":"One set of values the client sent for a proposal. A revision never changes.","required":["id","version","values","createdAt","createdByCredentialId"],"additionalProperties":false,"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"revisions.items.[INDEX].id","typeLabel":"string"},"version":{"type":"integer","minimum":1,"description":"1 for the values the proposal was created with, then one more for each set sent after.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].version","typeLabel":"integer"},"values":{"type":"object","additionalProperties":false,"description":"The values as the client sent them, without `externalReference`.","required":["planId","customerId","name","startedAt"],"properties":{"customerId":{"type":"string","pattern":"^cus_[a-zA-Z0-9]+$","description":"Unique identifier for a customer","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.customerId","typeLabel":"string"},"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":"revisions.items.[INDEX].values.name","typeLabel":"string"},"planId":{"type":"string","pattern":"^plan_[a-zA-Z0-9]+$","description":"Unique identifier for a plan","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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.","uniqueKey":"revisions.items.[INDEX].values.autoCharge","typeLabel":"boolean"},"taxExempt":{"type":"boolean","description":"When true, forces tax rate to 0%. Use for customers with verified tax-exempt status.","uniqueKey":"revisions.items.[INDEX].values.taxExempt","typeLabel":"boolean"},"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":"revisions.items.[INDEX].values.endingAt","typeLabel":"string\u003cdate-time>"},"prefundAmount":{"type":"string","deprecated":true,"description":"Deprecated. This field is ignored and has no effect.","uniqueKey":"revisions.items.[INDEX].values.prefundAmount","typeLabel":"string"},"minimumAccountBalance":{"type":"string","deprecated":true,"description":"Deprecated. This field is ignored and has no effect.","uniqueKey":"revisions.items.[INDEX].values.minimumAccountBalance","typeLabel":"string"},"redirectUrls":{"title":"SubscriptionProposalRedirectUrls","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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.redirectUrls.onFailure","typeLabel":"string\u003curi>"}},"uniqueKey":"revisions.items.[INDEX].values.redirectUrls","typeLabel":"SubscriptionProposalRedirectUrls · object"},"elapsedPeriodBilling":{"type":"string","enum":["none","per_period"],"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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.renewalReminderEnabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.renewalReminderDays.oneOf.1","typeLabel":"null"}],"uniqueKey":"revisions.items.[INDEX].values.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\"). A non-zero value needs `metadata.bankTransferOnly: true`; without it the request answers 400 `PAYMENT_TERM_DAYS_REQUIRES_BANK_TRANSFER_ONLY`.","minimum":0,"maximum":365,"uniqueKey":"revisions.items.[INDEX].values.paymentTermDays","typeLabel":"integer"},"sessionExpiryMinutes":{"type":"number","description":"Number of minutes until the payment session expires. Defaults to 240 minutes (4 hours) if not provided.","minimum":1,"uniqueKey":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.metadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"revisions.items.[INDEX].values.metadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"revisions.items.[INDEX].values.metadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"revisions.items.[INDEX].values.metadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.changeReason","typeLabel":"enum\u003cstring>"},"changeDescription":{"type":"string","maxLength":1000,"description":"A free-text note on why these intervals are changing.","uniqueKey":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.changeMetadata.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","maxLength":500,"uniqueKey":"revisions.items.[INDEX].values.changeMetadata.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","maxLength":500,"uniqueKey":"revisions.items.[INDEX].values.changeMetadata.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"revisions.items.[INDEX].values.changeMetadata.additionalProperties","typeLabel":"string | number | boolean"},"uniqueKey":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.addPrices.items.[INDEX].installments","typeLabel":"integer"},"amounts":{"type":"array","minItems":2,"maxItems":60,"items":{"type":"string","uniqueKey":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.addPrices.items.[INDEX].amounts","typeLabel":"string[]"}},"uniqueKey":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.overridePrices.items.[INDEX].overridesPriceId","typeLabel":"string"},"unitPrice":{"type":"string","description":"The agreed rate, as a decimal string.","uniqueKey":"revisions.items.[INDEX].values.overridePrices.items.[INDEX].unitPrice","typeLabel":"string"},"baseQuantity":{"type":"string","description":"The agreed quantity, as a decimal string.","uniqueKey":"revisions.items.[INDEX].values.overridePrices.items.[INDEX].baseQuantity","typeLabel":"string"}},"uniqueKey":"revisions.items.[INDEX].values.overridePrices.items.[INDEX]","typeLabel":"object"},"description":"Rate or quantity overrides for prices the plan version does carry.","uniqueKey":"revisions.items.[INDEX].values.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":"revisions.items.[INDEX].values.removePrices.items.[INDEX].priceId","typeLabel":"string"}},"uniqueKey":"revisions.items.[INDEX].values.removePrices.items.[INDEX]","typeLabel":"object"},"description":"Plan prices this subscription does not bill.","uniqueKey":"revisions.items.[INDEX].values.removePrices","typeLabel":"object[]"},"planVersionId":{"type":"string","description":"A published version of `planId` to pin the proposal to. Only a pinned proposal (`versionPolicy: \"pinned\"`) names a version. One that names none, or `null`, pins the plan's default version, as a change of `planId` without a version does. A floating proposal follows the plan's default version, and one that names a version is refused with 400.","uniqueKey":"revisions.items.[INDEX].values.planVersionId","typeLabel":"string"},"adjustments":{"type":"array","maxItems":25,"items":{"oneOf":[{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","percentageDiscount","effectiveFrom"],"properties":{"type":{"type":"string","enum":["percentageDiscount"],"description":"Reduces every discountable charge on the invoice by a rate.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"percentageDiscount":{"type":"string","description":"The discount rate as a decimal fraction between 0 and 1, sent as a string. \"0.35\" means 35 percent. \"1\" means 100 percent, not 1 percent. At most 6 decimal places. A value of 0 or above 1 is rejected.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0.percentageDiscount","typeLabel":"string"},"effectiveFrom":{"type":"string","format":"date-time","description":"The first instant the discount applies. Inclusive.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"The instant the discount stops applying. Exclusive, so a window ending on the same date another begins neither overlaps nor leaves a gap. Null means the discount never stops, and it cannot be ended later — set an instant whenever the deal has a known end date. Must be after effectiveFrom.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The instant the discount stops applying. Exclusive, so a window ending on the same date another begins neither overlaps nor leaves a gap. Null means the discount never stops, and it cannot be ended later — set an instant whenever the deal has a known end date. Must be after effectiveFrom.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"The deal's own name, shown on each discount line of the invoice.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The deal's own name, shown on each discount line of the invoice.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second adjustment, and two percentage discounts compound — two of 0.35 bill 57.75 percent off, not 35 percent.","example":"adj_fy26_growth_001","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","usageDiscount","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["usageDiscount"],"description":"Reduces one metered price's billable quantity by a number of usage units, before the line is priced.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"usageDiscount":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The number of usage units to take off the billable quantity, sent as a plain decimal string. \"300\" waives 300 units. Greater than 0, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. Applied in full or not at all — a unit count is never prorated across a partial window — and once per matching line, so an invoice bundling several periods is corrected on each of them. The line is floored at 0, so a discount larger than the billable quantity zeroes it rather than crediting. On a volume ladder the corrected quantity also re-selects the band, so a waiver that crosses a boundary can bill more than the uncorrected line did: waiving 300 of 1000 units on a ladder of 2.00 up to 999 and 1.00 beyond bills 700 at 2.00 for 1400.00, where the 1000 units billed 1000.00. That is the ladder's price for the corrected usage — what a customer who genuinely used 700 units pays — so check the ladder before waiving units near a band boundary.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.usageDiscount","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one metered price of this subscription, priced as standard or volume. Usage units are not comparable across metrics, so a usage discount names the one price it reduces. A dynamic or percentage price is refused: its quantity is a monetary amount rather than a unit count. A price billing at a negative rate (a usage-scaled rebate) is refused too, because removing its units would raise the invoice.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a metered line is corrected when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. Set it to the start of the period you are correcting.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, unlike percentageDiscount: a metered line bills in arrears, so set this to the exact period end you are correcting and that period is covered. Null means the discount never stops — it then takes its full unit count off this price on EVERY later invoice, so set both bounds whenever you are correcting one period. Must be after effectiveFrom.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, unlike percentageDiscount: a metered line bills in arrears, so set this to the exact period end you are correcting and that period is covered. Null means the discount never stops — it then takes its full unit count off this price on EVERY later invoice, so set both bounds whenever you are correcting one period. Must be after effectiveFrom.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this correction. A usageDiscount emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this correction. A usageDiscount emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second adjustment, and usage discounts against one price SUM — two of \"300\" waive 600 units, not 300. Nothing else detects a duplicate.","example":"adj_mar_outage_001","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","minimumQuantity","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["minimumQuantity"],"description":"Bills at least the contracted quantity on one price, whatever the customer actually used.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"minimumQuantity":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The contracted minimum quantity for one billing period of the target price, sent as a plain decimal string. Not negative, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. \"4\" bills 4 seats in a period the customer used 2 in; a value of 0 binds nothing. Measured over the whole billing period, not per line: where a period is split into several lines, each line's quantity counts for its share of the period, and every line is scaled by the same factor to bring the period to the minimum. Several bounds of the same direction on one price do not add up — the greatest minimum and the least maximum are the ones that apply.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.minimumQuantity","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one price of this subscription. A metered price is accepted, and so is a price whose supply is outside the scope of VAT: a bound constrains a measurement rather than an amount of consideration. A price that bills once rather than per period is refused, because there is no repeating period for the bound to be measured over.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a line is bounded when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. The bound is never prorated — a window opening mid-period applies to that whole period.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second bound; two identical bounds change nothing, because bounds of one direction do not add up.","example":"adj_fortress_seats_001","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"One adjustment to attach to the subscription. The type decides which number the body carries: a rate for percentageDiscount, a unit count and one target price for usageDiscount, and a contracted quantity and one target price for minimumQuantity and maximumQuantity.","required":["type","maximumQuantity","targetPriceIds","effectiveFrom"],"properties":{"type":{"type":"string","enum":["maximumQuantity"],"description":"Bills at most the contracted quantity on one price, whatever the customer actually used.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"maximumQuantity":{"type":"string","pattern":"^[0-9]+(\\.[0-9]+)?$","description":"The contracted maximum quantity for one billing period of the target price, sent as a plain decimal string. Not negative, at most 6 decimal places, fewer than 35 digits before the point. Plain notation only — no sign, exponent, hex or digit separators, so \"1_000\" and \"1e3\" are rejected rather than read as 1000. \"4\" bills 4 seats in a period the customer used 9 in; a value of 0 bills nothing at all. Measured over the whole billing period, not per line: where a period is split into several lines, each line's quantity counts for its share of the period, and every line is scaled by the same factor to bring the period to the maximum. Several bounds of the same direction on one price do not add up — the greatest minimum and the least maximum are the ones that apply.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.maximumQuantity","typeLabel":"string"},"targetPriceIds":{"type":"array","items":{"type":"string","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.targetPriceIds.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":1,"description":"Exactly one price of this subscription. A metered price is accepted, and so is a price whose supply is outside the scope of VAT: a bound constrains a measurement rather than an amount of consideration. A price that bills once rather than per period is refused, because there is no repeating period for the bound to be measured over.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.targetPriceIds","typeLabel":"string[]"},"effectiveFrom":{"type":"string","format":"date-time","description":"Opens the window. Exclusive for this type: a line is bounded when its period END falls after this instant, so a window opening exactly when a period ends belongs to the next period, not that one. The bound is never prorated — a window opening mid-period applies to that whole period.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.effectiveFrom","typeLabel":"string\u003cdate-time>"},"effectiveTo":{"oneOf":[{"type":"string","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.effectiveTo.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Closes the window. INCLUSIVE for this type, like usageDiscount and unlike percentageDiscount: set this to the exact period end you are bounding and that period is covered. Null means the bound never stops. Must be after effectiveFrom.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.effectiveTo.oneOf.1","typeLabel":"null"}],"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.effectiveTo","typeLabel":"string\u003cdate-time> | null"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Your own name for this term. A quantity bound emits no invoice line, so this is printed nowhere on the invoice — it is returned on the adjustment for your own records.","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.description","typeLabel":"string | null"},"idempotencyKey":{"type":"string","minLength":1,"maxLength":255,"description":"A key of your choosing that makes a retry safe. Sending the same key against the same subscription returns the adjustment already created and creates no second one. Without a key a retried request creates a second bound; two identical bounds change nothing, because bounds of one direction do not add up.","example":"adj_fortress_seats_001","uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3.idempotencyKey","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"revisions.items.[INDEX].values.adjustments.items.[INDEX]","typeLabel":"object"},"description":"Adjustments the subscription gets when the proposal is approved. Each is checked as subscription adjustment create checks it, against the prices the proposal bills and the other adjustments in this list.","uniqueKey":"revisions.items.[INDEX].values.adjustments","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"revisions.items.[INDEX].values","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"revisions.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"createdByCredentialId":{"oneOf":[{"type":"string","description":"The API key or OAuth client that sent the values; null for a dashboard session.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].createdByCredentialId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The API key or OAuth client that sent the values; null for a dashboard session.","isRequired":true,"uniqueKey":"revisions.items.[INDEX].createdByCredentialId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"revisions.items.[INDEX].createdByCredentialId","typeLabel":"string | null"}},"uniqueKey":"revisions.items.[INDEX]","typeLabel":"object"},"description":"Each set of values the client sent, earliest first. Present only with `expand=revisions`. The last one is `requested`.","uniqueKey":"revisions","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","object":"subscriptionProposal","merchantId":"\u003cstring>","status":"pending","customerId":"\u003cstring>","planId":"\u003cstring>","planVersionId":"\u003cstring>","resolvedPlanVersionId":"\u003cstring>","hash":"\u003cstring>","testClockId":"\u003cstring>","requested":{"customerId":"\u003cstring>","name":"\u003cstring>","planId":"\u003cstring>","startedAt":"2023-11-07T05:31:56Z","autoCharge":true,"taxExempt":true,"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,"versionPolicy":"floating","metadata":{},"changeReason":"commercial","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>"}],"planVersionId":"\u003cstring>","adjustments":[{"type":"percentageDiscount","percentageDiscount":"\u003cstring>","effectiveFrom":"2023-11-07T05:31:56Z","effectiveTo":"2023-11-07T05:31:56Z","description":"\u003cstring>","idempotencyKey":"adj_fy26_growth_001"}]},"current":{"customerId":"\u003cstring>","name":"\u003cstring>","planId":"\u003cstring>","startedAt":"2023-11-07T05:31:56Z","autoCharge":true,"taxExempt":true,"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,"versionPolicy":"floating","metadata":{},"changeReason":"commercial","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>"}],"planVersionId":"\u003cstring>","adjustments":[{"type":"percentageDiscount","percentageDiscount":"\u003cstring>","effectiveFrom":"2023-11-07T05:31:56Z","effectiveTo":"2023-11-07T05:31:56Z","description":"\u003cstring>","idempotencyKey":"adj_fy26_growth_001"}]},"amendedFields":["\u003cstring>"],"refusedResync":{"receivedAt":"2023-11-07T05:31:56Z","code":"SUBSCRIPTION_PROPOSAL_RESYNC_CONFLICT","fields":["\u003cstring>"],"values":{"customerId":"\u003cstring>","name":"\u003cstring>","planId":"\u003cstring>","startedAt":"2023-11-07T05:31:56Z","autoCharge":true,"taxExempt":true,"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,"versionPolicy":"floating","metadata":{},"changeReason":"commercial","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>"}],"planVersionId":"\u003cstring>","adjustments":[{"type":"percentageDiscount","percentageDiscount":"\u003cstring>","effectiveFrom":"2023-11-07T05:31:56Z","effectiveTo":"2023-11-07T05:31:56Z","description":"\u003cstring>","idempotencyKey":"adj_fy26_growth_001"}]},"credentialId":"\u003cstring>"},"lockVersion":123,"source":"\u003cstring>","externalReference":{"provider":"\u003cstring>","externalId":"\u003cstring>"},"subscriptionId":"\u003cstring>","rejectionReason":"price_mismatch","rejectionText":"\u003cstring>","decidedAt":"2023-11-07T05:31:56Z","decidedByPrincipalId":"\u003cstring>","decidedBy":{"type":"user","name":"\u003cstring>"},"strandedAt":"2023-11-07T05:31:56Z","createdByPrincipalId":"\u003cstring>","createdByCredentialId":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","revisions":[{"id":"\u003cstring>","version":2,"values":{"customerId":"\u003cstring>","name":"\u003cstring>","planId":"\u003cstring>","startedAt":"2023-11-07T05:31:56Z","autoCharge":true,"taxExempt":true,"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,"versionPolicy":"floating","metadata":{},"changeReason":"commercial","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>"}],"planVersionId":"\u003cstring>","adjustments":[{"type":"percentageDiscount","percentageDiscount":"\u003cstring>","effectiveFrom":"2023-11-07T05:31:56Z","effectiveTo":"2023-11-07T05:31:56Z","description":"\u003cstring>","idempotencyKey":"adj_fy26_growth_001"}]},"createdAt":"2023-11-07T05:31:56Z","createdByCredentialId":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"e6e33e0a-586e-496a-b6b2-eefad1cfe0e4":{"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"},"cf8d310b-5572-4b50-ad1c-a2c865f0b79c":{"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"},"6f62397a-782a-484e-b6a5-5a46b82320db":{"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"},"72d36434-5a8b-43dd-872c-28f56dcc3bb8":{"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"},"dc29ccbe-ae6e-429f-915b-db47f8e150fa":{"description":"A re-sync refused: `SUBSCRIPTION_PROPOSAL_RESYNC_CONFLICT` or `SUBSCRIPTION_PROPOSAL_ALREADY_APPROVED`","content":{"application/json":{"schema":{"type":"object","required":["error","message"],"description":"A 409 of a proposal route. Branch on `code`, never on `message`.","properties":{"error":{"title":"SubscriptionProposalConflictErrorType","type":"string","enum":["conflict"],"isRequired":true,"uniqueKey":"error","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","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"},"code":{"type":"string","enum":["SUBSCRIPTION_PROPOSAL_RESYNC_CONFLICT","SUBSCRIPTION_PROPOSAL_ALREADY_APPROVED","SUBSCRIPTION_PROPOSAL_NOT_PENDING","SUBSCRIPTION_PROPOSAL_CHANGED","SUBSCRIPTION_PROPOSAL_DUPLICATE","SUBSCRIPTION_PROPOSAL_INVALID"],"x-speakeasy-unknown-values":"allow","description":"Why a proposal route answered 409. `RESYNC_CONFLICT`: a re-sync changed a field a person amended; stop, a person rejects and the CRM sends again. `ALREADY_APPROVED`: the proposal is approved; stop. `NOT_PENDING`: the proposal is decided; stop. `CHANGED`: the proposal changed since it was read; read it again and retry. `DUPLICATE`: the customer already has a live subscription for the product; reject the proposal. `INVALID`: the proposal now fails a check of subscription create; amend or reject it. Open set: approve can pass on a conflict of subscription create with that conflict's own code, so treat any other code as an unhandled conflict.","uniqueKey":"code","typeLabel":"enum\u003cstring>"},"details":{"type":"object","additionalProperties":true,"description":"What the conflict names. Which fields are set depends on `code`.","properties":{"code":{"type":"string","description":"On `SUBSCRIPTION_PROPOSAL_INVALID`, the failed check's own code, when it has one. On the other codes, the conflict's `code` again.","uniqueKey":"details.code","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"On `SUBSCRIPTION_PROPOSAL_INVALID`, the failed check's own details, when it has them.","uniqueKey":"details.details","typeLabel":"object"},"fields":{"type":"array","items":{"type":"string","uniqueKey":"details.fields.items.[INDEX]","typeLabel":"string"},"description":"On `SUBSCRIPTION_PROPOSAL_RESYNC_CONFLICT`, the fields that conflict with an amendment.","uniqueKey":"details.fields","typeLabel":"string[]"},"subscriptionId":{"type":"string","description":"On `SUBSCRIPTION_PROPOSAL_ALREADY_APPROVED`, the subscription the proposal created. On `SUBSCRIPTION_PROPOSAL_DUPLICATE`, the customer's live subscription for the product.","uniqueKey":"details.subscriptionId","typeLabel":"string"},"status":{"type":"string","description":"On `SUBSCRIPTION_PROPOSAL_NOT_PENDING`, the proposal's status.","uniqueKey":"details.status","typeLabel":"string"},"field":{"type":"string","description":"On `SUBSCRIPTION_PROPOSAL_CHANGED` from approve's compare-and-set, `lockVersion`, the compared field.","uniqueKey":"details.field","typeLabel":"string"},"expected":{"oneOf":[{"type":"integer","description":"On `SUBSCRIPTION_PROPOSAL_CHANGED` from approve's compare-and-set, the `lockVersion` the proposal holds.","uniqueKey":"details.expected.oneOf.0","typeLabel":"integer"},{"type":"null","description":"On `SUBSCRIPTION_PROPOSAL_CHANGED` from approve's compare-and-set, the `lockVersion` the proposal holds.","uniqueKey":"details.expected.oneOf.1","typeLabel":"null"}],"uniqueKey":"details.expected","typeLabel":"integer | null"},"actual":{"type":"integer","description":"On `SUBSCRIPTION_PROPOSAL_CHANGED` from approve's compare-and-set, the `lockVersion` approve read.","uniqueKey":"details.actual","typeLabel":"integer"},"entityType":{"type":"string","uniqueKey":"details.entityType","typeLabel":"string"},"entityId":{"type":"string","uniqueKey":"details.entityId","typeLabel":"string"}},"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"conflict","message":"\u003cstring>","requestId":"105445aa7843bc8bf206b12000100000","code":"SUBSCRIPTION_PROPOSAL_RESYNC_CONFLICT","details":{"code":"\u003cstring>","details":{},"fields":["\u003cstring>"],"subscriptionId":"\u003cstring>","status":"\u003cstring>","field":"\u003cstring>","expected":123,"actual":123,"entityType":"\u003cstring>","entityId":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"ddce70b5-8c6f-4f08-be81-b11ef3f848f2":{"description":"Another request is changing this record's subscription proposal, or its customer. Retry after the time in the Retry-After header.","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"},"7f5040a0-3aac-4a72-89d2-b1f97fa59d6a":{"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":{"5c888a87-14a3-4f77-a118-202bb1f6a955":{"BearerAuth":{"type":"http","scheme":"bearer","description":"API key authentication","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"0ff10ce3-51b6-430b-80a4-c0988a44c6e6":{"url":"https://api.paygentic.io","description":"Production API"},"d6c1ad05-2e8d-47a6-968b-204465b448ac":{"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-18T08:02:36.227Z","originalFileLocation":"api-reference/subscription-proposals/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 pending subscription proposal from the values of a subscription create. The customer must already exist. A plan or customer of another merchant answers 404, as an unknown one does. The values are checked as subscription create checks them, at the moment of the request, but no subscription, invoice or entitlement exists until a person approves the proposal. With an externalReference, the create first finds the proposal that record already has: its pending or approved proposal, else its most recent rejected one. Sends of one record are handled one at a time. Values are compared after normalization: key order does not count, a field sent with its default equals the field left out, and two forms of one instant, such as Z and +00:00, are equal. - None found: a new proposal, 201. - Values equal to that proposal\u0026#x27;s requested: the proposal, 200. Nothing is checked. A stored refusedResync is cleared, which raises lockVersion and changes hash; without one, nothing is written. - A pending proposal, values changed: the values become the next revision and requested. current takes each changed field except a field in amendedFields, which keeps the person\u0026#x27;s value, and a field left out returns to its default. The result is checked as an amend is, and answered 200. - A pending proposal whose change conflicts with an amendment: 409 SUBSCRIPTION_PROPOSAL_RESYNC_CONFLICT, and current and requested do not change. details.fields names each conflicting field. A field conflicts when the client changed it, a person amended it, and the new value differs from current. Leaving out a field the previous send set changes it to its default, so leaving out an amended field conflicts too. A change also conflicts when it would leave price fields (planVersionId, overridePrices, addPrices, removePrices, adjustments) naming another plan\u0026#x27;s prices, and when it would change versionPolicy while planVersionId is amended. - An approved proposal, values changed: 409 SUBSCRIPTION_PROPOSAL_ALREADY_APPROVED, with the subscription\u0026#x27;s id in details.subscriptionId. Changes to an active subscription are not supported yet. - A rejected proposal, values changed: a new proposal, 201. The rejected one is unchanged. A refused send is kept on the proposal as refusedResync, so a reviewer sees it. A send that repeats the stored refusal changes nothing.\">\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 pending subscription proposal from the values of a subscription create. The customer must already exist. A plan or customer of another merchant answers 404, as an unknown one does. The values are checked as subscription create checks them, at the moment of the request, but no subscription, invoice or entitlement exists until a person approves the proposal. With an externalReference, the create first finds the proposal that record already has: its pending or approved proposal, else its most recent rejected one. Sends of one record are handled one at a time. Values are compared after normalization: key order does not count, a field sent with its default equals the field left out, and two forms of one instant, such as Z and +00:00, are equal. - None found: a new proposal, 201. - Values equal to that proposal\u0026#x27;s requested: the proposal, 200. Nothing is checked. A stored refusedResync is cleared, which raises lockVersion and changes hash; without one, nothing is written. - A pending proposal, values changed: the values become the next revision and requested. current takes each changed field except a field in amendedFields, which keeps the person\u0026#x27;s value, and a field left out returns to its default. The result is checked as an amend is, and answered 200. - A pending proposal whose change conflicts with an amendment: 409 SUBSCRIPTION_PROPOSAL_RESYNC_CONFLICT, and current and requested do not change. details.fields names each conflicting field. A field conflicts when the client changed it, a person amended it, and the new value differs from current. Leaving out a field the previous send set changes it to its default, so leaving out an amended field conflicts too. A change also conflicts when it would leave price fields (planVersionId, overridePrices, addPrices, removePrices, adjustments) naming another plan\u0026#x27;s prices, and when it would change versionPolicy while planVersionId is amended. - An approved proposal, values changed: 409 SUBSCRIPTION_PROPOSAL_ALREADY_APPROVED, with the subscription\u0026#x27;s id in details.subscriptionId. Changes to an active subscription are not supported yet. - A rejected proposal, values changed: a new proposal, 201. The rejected one is unchanged. A refused send is kept on the proposal as refusedResync, so a reviewer sees it. A send that repeats the stored refusal changes nothing.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Paygentic\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.paygentic.io/api-reference/subscription-proposals/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=Subscription+Proposals\u0026amp;title=Create\u0026amp;description=Creates+a+pending+subscription+proposal+from+the+values+of+a+subscription+create.+The+customer+must+already+exist.+A+plan+or+customer+of+another+merchant+answer\u0026amp;theme=6ad1713123e6dfef0529ce98\u0026amp;signature=1b2a4aea545857bd439942622af5578670359b576ac4b3674a1f26a3e876ec9c\">\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 pending subscription proposal from the values of a subscription create. The customer must already exist. A plan or customer of another merchant answers 404, as an unknown one does. The values are checked as subscription create checks them, at the moment of the request, but no subscription, invoice or entitlement exists until a person approves the proposal. With an externalReference, the create first finds the proposal that record already has: its pending or approved proposal, else its most recent rejected one. Sends of one record are handled one at a time. Values are compared after normalization: key order does not count, a field sent with its default equals the field left out, and two forms of one instant, such as Z and +00:00, are equal. - None found: a new proposal, 201. - Values equal to that proposal\u0026#x27;s requested: the proposal, 200. Nothing is checked. A stored refusedResync is cleared, which raises lockVersion and changes hash; without one, nothing is written. - A pending proposal, values changed: the values become the next revision and requested. current takes each changed field except a field in amendedFields, which keeps the person\u0026#x27;s value, and a field left out returns to its default. The result is checked as an amend is, and answered 200. - A pending proposal whose change conflicts with an amendment: 409 SUBSCRIPTION_PROPOSAL_RESYNC_CONFLICT, and current and requested do not change. details.fields names each conflicting field. A field conflicts when the client changed it, a person amended it, and the new value differs from current. Leaving out a field the previous send set changes it to its default, so leaving out an amended field conflicts too. A change also conflicts when it would leave price fields (planVersionId, overridePrices, addPrices, removePrices, adjustments) naming another plan\u0026#x27;s prices, and when it would change versionPolicy while planVersionId is amended. - An approved proposal, values changed: 409 SUBSCRIPTION_PROPOSAL_ALREADY_APPROVED, with the subscription\u0026#x27;s id in details.subscriptionId. Changes to an active subscription are not supported yet. - A rejected proposal, values changed: a new proposal, 201. The rejected one is unchanged. A refused send is kept on the proposal as refusedResync, so a reviewer sees it. A send that repeats the stored refusal changes nothing.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paygentic.mintlify.site/_mintlify/api/og/v2?division=Subscription+Proposals\u0026amp;title=Create\u0026amp;description=Creates+a+pending+subscription+proposal+from+the+values+of+a+subscription+create.+The+customer+must+already+exist.+A+plan+or+customer+of+another+merchant+answer\u0026amp;theme=6ad1713123e6dfef0529ce98\u0026amp;signature=1b2a4aea545857bd439942622af5578670359b576ac4b3674a1f26a3e876ec9c\">\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/subscription-proposals/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/subscription-proposals/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/subscription-proposals/create#webpage\",\"url\":\"https://docs.paygentic.io/api-reference/subscription-proposals/create\",\"name\":\"Create\",\"description\":\"Creates a pending subscription proposal from the values of a subscription create. The customer must already exist. A plan or customer of another merchant answers 404, as an unknown one does. The values are checked as subscription create checks them, at the moment of the request, but no subscription, invoice or entitlement exists until a person approves the proposal. With an externalReference, the create first finds the proposal that record already has: its pending or approved proposal, else its most recent rejected one. Sends of one record are handled one at a time. Values are compared after normalization: key order does not count, a field sent with its default equals the field left out, and two forms of one instant, such as Z and +00:00, are equal. - None found: a new proposal, 201. - Values equal to that proposal's requested: the proposal, 200. Nothing is checked. A stored refusedResync is cleared, which raises lockVersion and changes hash; without one, nothing is written. - A pending proposal, values changed: the values become the next revision and requested. current takes each changed field except a field in amendedFields, which keeps the person's value, and a field left out returns to its default. The result is checked as an amend is, and answered 200. - A pending proposal whose change conflicts with an amendment: 409 SUBSCRIPTION_PROPOSAL_RESYNC_CONFLICT, and current and requested do not change. details.fields names each conflicting field. A field conflicts when the client changed it, a person amended it, and the new value differs from current. Leaving out a field the previous send set changes it to its default, so leaving out an amended field conflicts too. A change also conflicts when it would leave price fields (planVersionId, overridePrices, addPrices, removePrices, adjustments) naming another plan's prices, and when it would change versionPolicy while planVersionId is amended. - An approved proposal, values changed: 409 SUBSCRIPTION_PROPOSAL_ALREADY_APPROVED, with the subscription's id in details.subscriptionId. Changes to an active subscription are not supported yet. - A rejected proposal, values changed: a new proposal, 201. The rejected one is unchanged. A refused send is kept on the proposal as refusedResync, so a reviewer sees it. A send that repeats the stored refusal changes nothing.\",\"dateModified\":\"2026-11-18T08:02:36.227Z\",\"isPartOf\":{\"@id\":\"https://docs.paygentic.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.paygentic.io/api-reference/subscription-proposals/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.paygentic.io/api-reference/subscription-proposals/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Subscription Proposals\",\"item\":\"https://docs.paygentic.io/api-reference/subscription-proposals/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create\",\"item\":\"https://docs.paygentic.io/api-reference/subscription-proposals/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.paygentic.io/api-reference/subscription-proposals/create#apireference\",\"headline\":\"Create\",\"name\":\"Create\",\"description\":\"Creates a pending subscription proposal from the values of a subscription create. The customer must already exist. A plan or customer of another merchant answers 404, as an unknown one does. The values are checked as subscription create checks them, at the moment of the request, but no subscription, invoice or entitlement exists until a person approves the proposal. With an externalReference, the create first finds the proposal that record already has: its pending or approved proposal, else its most recent rejected one. Sends of one record are handled one at a time. Values are compared after normalization: key order does not count, a field sent with its default equals the field left out, and two forms of one instant, such as Z and +00:00, are equal. - None found: a new proposal, 201. - Values equal to that proposal's requested: the proposal, 200. Nothing is checked. A stored refusedResync is cleared, which raises lockVersion and changes hash; without one, nothing is written. - A pending proposal, values changed: the values become the next revision and requested. current takes each changed field except a field in amendedFields, which keeps the person's value, and a field left out returns to its default. The result is checked as an amend is, and answered 200. - A pending proposal whose change conflicts with an amendment: 409 SUBSCRIPTION_PROPOSAL_RESYNC_CONFLICT, and current and requested do not change. details.fields names each conflicting field. A field conflicts when the client changed it, a person amended it, and the new value differs from current. Leaving out a field the previous send set changes it to its default, so leaving out an amended field conflicts too. A change also conflicts when it would leave price fields (planVersionId, overridePrices, addPrices, removePrices, adjustments) naming another plan's prices, and when it would change versionPolicy while planVersionId is amended. - An approved proposal, values changed: 409 SUBSCRIPTION_PROPOSAL_ALREADY_APPROVED, with the subscription's id in details.subscriptionId. Changes to an active subscription are not supported yet. - A rejected proposal, values changed: a new proposal, 201. The rejected one is unchanged. A refused send is kept on the proposal as refusedResync, so a reviewer sees it. A send that repeats the stored refusal changes nothing.\",\"url\":\"https://docs.paygentic.io/api-reference/subscription-proposals/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.paygentic.io/api-reference/subscription-proposals/create#webpage\"},\"dateModified\":\"2026-11-18T08:02:36.227Z\",\"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/subscription-proposals/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","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","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","description":"Lists the subscription proposals you can read, newest first. Filter by `status` to list, for example, the proposals waiting for a decision: `pagination.total` then counts them. Pass `merchantId` to list one merchant's proposals. A `merchantId` you cannot read answers 403, not an empty page.","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","description":"Returns one subscription proposal. Pass `expand=revisions` to add each set of values its client sent, earliest first. A proposal of another merchant answers 404, as an unknown one does.","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_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","Page-CnLhKuUV.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-KcneGfMY.js"]}