Audience: consumer · Trigger: AllRide schedules a change of your Price Terms · Payload:{resource, id, startsAt, voucherSets} · Permission: subscribing needs view-consumer-pricing
Pricing event. Subscribing requires view-consumer-pricing. See Pricing webhooks.
Verify the x-signing-signature header before you trust the body (Verifying signatures). Deliveries are at least once and unordered; deduplicate on event.id.
t=<unix seconds>,s1=<hex HMAC-SHA256 of "<raw body>.<t>" with your first secret>,s2=<the same with your second secret>. Accept the delivery when either signature matches. See Verifying signatures.
The resource the event is about, starting with resource and id: the consumer view of the resource, or the fields this event type defines.
Show child attributes
Response
Acknowledge receipt within 15 seconds.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"AllRide Vouchers — Consumer API","colors":{"primary":"#0A0A0A","light":"#FAFAFA","dark":"#0A0A0A"},"logo":{"light":"https://mintcdn.com/allride-voucher-consumer/9vqpJaAUcuaHTUy2/logo/light.svg?fit=max\u0026auto=format\u0026n=9vqpJaAUcuaHTUy2\u0026q=85\u0026s=92f0ea94edcefc1febba871b5ead8cdd","dark":"https://mintcdn.com/allride-voucher-consumer/9vqpJaAUcuaHTUy2/logo/dark.svg?fit=max\u0026auto=format\u0026n=9vqpJaAUcuaHTUy2\u0026q=85\u0026s=c5e31c42ccee8249e8a321e4a1064b5d","href":"https://docs-consumer.voucher.allride.io"},"favicon":"https://mintcdn.com/allride-voucher-consumer/9vqpJaAUcuaHTUy2/favicon.svg?fit=max\u0026auto=format\u0026n=9vqpJaAUcuaHTUy2\u0026q=85\u0026s=7a8b0fcba322123aacae3e4c870276d3","api":{"playground":{"display":"interactive","proxy":true},"examples":{"defaults":"required","languages":["curl","javascript","python","java","go","php"]}},"navbar":{"links":[{"href":"https://consumer-developers.voucher-staging.allride.io/go/overview","label":"Sandbox dashboard"},{"href":"https://allride.io","label":"Support"}],"primary":{"type":"button","label":"Developer dashboard","href":"https://consumer-developers.voucher.allride.io/go/api-keys"}},"footer":{"links":[{"header":"AllRide","items":[{"label":"Imprint","href":"https://www.allride.io/impressum"},{"label":"Privacy","href":"https://www.allride.io/datenschutz"}]}]},"seo":{"indexing":"navigable"},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"allride-voucher-consumer","hasAudioNarration":false,"actualSubdomain":"allride-voucher-consumer","customDomains":[],"gitSource":{"type":"github","owner":"allride-mobility","repo":"allridevoucherpartnerconsumerapidocs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6adf634194b1979157fe3cae"},"chroma":{"latestBuiltDeploymentHistoryId":"6ae9bdb007405bf5d5959ed9","collectionId":"b9f9a568-3bc7-4868-ba2c-e500f0d532c1","liveDeploymentHistoryId":"6ae9bdb007405bf5d5959ed9","schemaVersion":"v3"},"entitlements":{},"buildId":"6ae9c317bf4ef845262b05b7","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API reference","count":141},{"language":"default","tag":"Consumer API","count":72},{"language":"default","tag":"Workspace API","count":69},{"language":"default","tag":"Guides","count":34},{"language":"default","tag":"Webhook events","count":24},{"language":"default","tag":"Billing","count":20},{"language":"default","tag":"Catalog","count":15},{"language":"default","tag":"Email (SMTP and templates)","count":15},{"language":"default","tag":"Webhook endpoints","count":12},{"language":"default","tag":"Consumer guides","count":10}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"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":"llms-txt-v2","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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"html:not(.dark) .method-nav-pill .text-green-700{color:#14532d}html:not(.dark) .method-nav-pill .text-blue-700{color:#1e3a8a}html:not(.dark) .method-nav-pill .text-red-700{color:#7f1d1d}html:not(.dark) .method-nav-pill .text-orange-700{color:#7c2d12}html:not(.dark) .method-nav-pill .text-yellow-700{color:#713f12}html:not(.dark) .method-nav-pill .text-purple-700{color:#581c87}html:not(.dark) [data-component-part=field-required-pill]{color:#991b1b}"}],"page":{"pagePath":"webhooks/events/price-terms-change-scheduled","slug":"/webhooks/events/price-terms-change-scheduled","pageMetadata":{"title":"price-terms-change-scheduled","description":"A price change was scheduled","openapi":"openapi/consumer.v1.json webhook price-terms-change-scheduled","href":"/webhooks/events/price-terms-change-scheduled"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"A price change was scheduled\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Audience:`}),` consumer · `,_jsx(_components.strong,{children:`Trigger:`}),` AllRide schedules a change of your Price Terms · `,_jsx(_components.strong,{children:`Payload:`}),` `,_jsx(_components.code,{children:`{resource, id, startsAt, voucherSets}`}),` · `,_jsx(_components.strong,{children:`Permission:`}),` subscribing needs `,_jsx(_components.code,{children:`view-consumer-pricing`})]}),`\n`,_jsxs(Note,{children:[`Pricing event. Subscribing requires `,_jsx(_components.code,{children:`view-consumer-pricing`}),`. See `,_jsx(_components.a,{href:`/consumer/prices#pricing-webhooks`,children:`Pricing webhooks`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Verify the `,_jsx(_components.code,{children:`x-signing-signature`}),` header before you trust the body (`,_jsx(_components.a,{href:`/webhooks/verify-signatures`,children:`Verifying signatures`}),`). Deliveries are at least once and unordered; deduplicate on `,_jsx(_components.code,{children:`event.id`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"price-terms-change-scheduled","description":"A price change was scheduled","openapi":"openapi/consumer.v1.json webhook price-terms-change-scheduled","href":"/webhooks/events/price-terms-change-scheduled"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"A price change was scheduled","description":"A price change was scheduled","operationId":"webhook.price-terms-change-scheduled","x-audience":"consumer","parameters":["529b1d43-88b9-480a-84a4-942d41cf8db3"],"requestBody":"da836a2e-d259-4d08-bba2-f72259f3afbc","responses":{"2XX":"73ba463a-e941-498f-b42c-d45bf3b4394f","default":"71ba7d99-332e-4a0e-be21-eb5a84f6a8d9"},"method":"post","type":"webhook","servers":["194c8b4a-ee81-4799-8d91-168cc798538c"],"security":["e665e8eb-c733-4f11-acb6-1852122ca357"],"path":"price-terms-change-scheduled","baseUrlOptions":["https://api.voucher-staging.allride.io"],"title":"A price change was scheduled","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","java","go","php"],"requiredOnlyExamples":true,"requestExamples":[{"language":"json","filename":"default","code":"{\n \"event\": {\n \"id\": \"3f1c9a52-7b4e-4d21-9c6a-0e5d8b2f4a17\",\n \"type\": \"price-terms-change-scheduled\",\n \"timestamp\": 1793610900\n },\n \"payload\": {\n \"resource\": \"price-change\",\n \"id\": 7301,\n \"startsAt\": \"2026-11-30T23:00:00Z\",\n \"voucherSets\": [\n {\n \"id\": 2030,\n \"resource\": \"voucher-set-price-terms\",\n \"voucherSetId\": 2030,\n \"providerPartnerId\": 1030,\n \"provider\": {\n \"id\": 1030,\n \"resource\": \"partner\",\n \"name\": \"Acme Scooters\",\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.voucher.allride.io/consumer/v1/catalog/providers/1030\",\n \"type\": \"application/json\"\n }\n }\n },\n \"voucherSetName\": {\n \"de\": \"Acme Starter Pass\",\n \"en\": \"Acme Starter Pass\"\n },\n \"status\": \"change-pending\",\n \"nextChangeAt\": \"2026-11-30T23:00:00Z\",\n \"current\": {\n \"startsAt\": \"2025-12-31T23:00:00Z\",\n \"endsAt\": \"2026-11-30T23:00:00Z\",\n \"terms\": {\n \"pricingModel\": \"per-unit\",\n \"unitPrice\": {\n \"value\": 800,\n \"scale\": 4,\n \"label\": \"€0.08\"\n },\n \"tiers\": null\n },\n \"termsDigest\": \"4f0c2a9e7b13d5c8e1f6a0b2c4d6e8f0a1b3c5d7e9f1a3b5c7d9e1f3a5b7c9d1\",\n \"acceptBy\": \"2025-12-31T23:00:00Z\",\n \"acceptance\": {\n \"status\": \"accepted\",\n \"priceAcceptanceId\": 61017,\n \"acceptedAt\": \"2026-01-03T09:12:00Z\",\n \"acceptedBy\": {\n \"type\": \"partner-user\",\n \"id\": 4069,\n \"label\": \"[email protected]\"\n }\n }\n },\n \"upcoming\": [\n {\n \"startsAt\": \"2026-11-30T23:00:00Z\",\n \"endsAt\": null,\n \"terms\": {\n \"pricingModel\": \"per-unit\",\n \"unitPrice\": {\n \"value\": 1000,\n \"scale\": 4,\n \"label\": \"€0.10\"\n },\n \"tiers\": null\n },\n \"termsDigest\": \"9a17e3c5b7d9f1a3c5e7a9b1d3f5a7c9e1b3d5f7a9c1e3b5d7f9a1c3e5b7d9f1\",\n \"acceptBy\": \"2026-11-30T23:00:00Z\",\n \"acceptance\": {\n \"status\": \"pending\"\n }\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://api.voucher.allride.io/consumer/v1/pricing/voucher-sets/2030\",\n \"type\": \"application/json\"\n },\n \"voucherSet\": {\n \"href\": \"https://api.voucher.allride.io/consumer/v1/catalog/voucher-sets/2030\",\n \"type\": \"application/json\"\n }\n }\n }\n ]\n }\n}"}],"requestExampleType":"webhook","responseExampleType":"generated"},"dependencies":{"parameters":{"529b1d43-88b9-480a-84a4-942d41cf8db3":{"name":"x-signing-signature","in":"header","required":true,"description":"`t=\u003cunix seconds>,s1=\u003chex HMAC-SHA256 of \"\u003craw body>.\u003ct>\" with your first secret>,s2=\u003cthe same with your second secret>`. Accept the delivery when either signature matches. See [Verifying signatures](/webhooks/verify-signatures).","schema":{"type":"string","isRequired":true,"description":"`t=\u003cunix seconds>,s1=\u003chex HMAC-SHA256 of \"\u003craw body>.\u003ct>\" with your first secret>,s2=\u003cthe same with your second secret>`. Accept the delivery when either signature matches. See [Verifying signatures](/webhooks/verify-signatures).","uniqueKey":"","typeLabel":"string"},"example":"t=1793610900,s1=5d1c…,s2=a07e…"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Body of a `price-terms-change-scheduled` webhook.","properties":{"event":{"type":"object","description":"The event.","properties":{"id":{"type":"string","format":"uuid","description":"Event id. Identical on every attempt and replay of this event; deduplicate on it.","isRequired":true,"uniqueKey":"event.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","const":"price-terms-change-scheduled","description":"Event type.","isRequired":true,"uniqueKey":"event.type","typeLabel":"string"},"timestamp":{"type":"integer","format":"int64","description":"When AllRide created the event, in Unix seconds (UTC). Identical on every attempt; the signing time is `t` of `x-signing-signature`.","isRequired":true,"uniqueKey":"event.timestamp","typeLabel":"integer\u003cint64>"}},"required":["id","type","timestamp"],"additionalProperties":false,"isRequired":true,"uniqueKey":"event","typeLabel":"object"},"payload":{"type":"object","properties":{"resource":{"type":"string","enum":["price-change"],"description":"Always `price-change`.","isRequired":true,"uniqueKey":"payload.resource","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Id of the price change.","isRequired":true,"uniqueKey":"payload.id","typeLabel":"integer\u003cuint64>"},"startsAt":{"type":"string","format":"date-time","description":"When the new terms start.","example":"2026-11-01T00:00:00Z","isRequired":true,"uniqueKey":"payload.startsAt","typeLabel":"string\u003cdate-time>"},"voucherSets":{"type":"array","items":{"type":"object","description":"Your resolved Price Terms for one visible voucher set: current and up to 5 upcoming periods. `id` is the voucher set id. Never contains price rules.","properties":{"id":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Numeric id of the resource, unique per resource type.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].id","typeLabel":"integer\u003cuint64>"},"resource":{"type":"string","enum":["voucher-set-price-terms"],"description":"Always `voucher-set-price-terms`.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].resource","typeLabel":"enum\u003cstring>"},"voucherSetId":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"The voucher set (equal to `id`).","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].voucherSetId","typeLabel":"integer\u003cuint64>"},"providerPartnerId":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Provider of the voucher set.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].providerPartnerId","typeLabel":"integer\u003cuint64>"},"provider":{"type":"object","properties":{"id":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"Provider id.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].provider.id","typeLabel":"integer\u003cuint64>"},"resource":{"type":"string","enum":["partner"],"description":"Always `partner`.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].provider.resource","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"Provider name.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].provider.name","typeLabel":"string"},"_links":{"type":"object","properties":{"self":{"type":"object","description":"The catalog provider.","properties":{"href":{"type":"string","format":"uri","description":"Absolute URL.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].provider._links.self.href","typeLabel":"string\u003curi>"},"type":{"type":"string","description":"Media type of the target, usually `application/json`.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].provider._links.self.type","typeLabel":"string"}},"required":["href","type"],"additionalProperties":false,"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].provider._links.self","typeLabel":"object"}},"required":["self"],"additionalProperties":false,"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].provider._links","typeLabel":"object"}},"required":["id","resource","name","_links"],"additionalProperties":false,"description":"The provider.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].provider","typeLabel":"object"},"voucherSetName":{"type":"object","description":"Name of the live revision.","properties":{"de":{"type":"string","description":"German text.","uniqueKey":"payload.voucherSets.items.[INDEX].voucherSetName.de","typeLabel":"string"},"en":{"type":"string","description":"English text.","uniqueKey":"payload.voucherSets.items.[INDEX].voucherSetName.en","typeLabel":"string"}},"additionalProperties":false,"example":{"de":"5 € Fahrguthaben","en":"€5 ride credit"},"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].voucherSetName","typeLabel":"object"},"status":{"type":"string","enum":["accepted","change-pending","acceptance-required","not-priced","exempt"],"description":"Your price acceptance status now: `accepted`, `change-pending` (redeemable; upcoming terms not yet accepted), `acceptance-required` (not redeemable until you accept), `not-priced` (not redeemable), `exempt`. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"nextChangeAt":{"oneOf":[{"type":"string","description":"Start of the next period, or the end of the current one; `null` when nothing changes.","format":"date-time","example":"2026-11-01T00:00:00Z","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].nextChangeAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Start of the next period, or the end of the current one; `null` when nothing changes.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].nextChangeAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].nextChangeAt","typeLabel":"string\u003cdate-time> | null"},"current":{"oneOf":[{"type":"object","description":"The period in force now; `null` when the set is not priced now.","required":["startsAt","endsAt","terms","termsDigest","acceptBy","acceptance"],"properties":{"startsAt":{"type":"string","format":"date-time","description":"Start of the period (UTC).","example":"2026-11-01T00:00:00Z","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.startsAt","typeLabel":"string\u003cdate-time>"},"endsAt":{"oneOf":[{"type":"string","description":"End of the period (exclusive); `null` when open-ended.","format":"date-time","example":"2026-11-01T00:00:00Z","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.endsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"End of the period (exclusive); `null` when open-ended.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.endsAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.endsAt","typeLabel":"string\u003cdate-time> | null"},"terms":{"type":"object","description":"The resolved Price Terms of the period.","properties":{"pricingModel":{"type":"string","enum":["per-unit","graduated"],"description":"`per-unit`: one unit price; `graduated`: tiers by the n-th redemption of the month. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.terms.pricingModel","typeLabel":"enum\u003cstring>"},"unitPrice":{"oneOf":[{"type":"object","description":"Price per redemption (`per-unit`); `null` for `graduated`.","required":["value","scale","label"],"example":{"value":1250,"scale":4},"properties":{"value":{"type":"integer","minimum":0,"maximum":100000000,"description":"Price in 1/10,000 euro.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.terms.unitPrice.oneOf.0.value","typeLabel":"integer"},"scale":{"type":"integer","const":4,"description":"Always 4.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.terms.unitPrice.oneOf.0.scale","typeLabel":"integer"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.terms.unitPrice.oneOf.0","typeLabel":"object"},{"type":"null","description":"Price per redemption (`per-unit`); `null` for `graduated`.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.terms.unitPrice.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.terms.unitPrice","typeLabel":"object | null"},"tiers":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"upTo":{"oneOf":[{"type":"integer","description":"Last redemption number (in the month) this tier covers; `null` on the last tier.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.terms.tiers.oneOf.0.items.[INDEX].upTo.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Last redemption number (in the month) this tier covers; `null` on the last tier.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.terms.tiers.oneOf.0.items.[INDEX].upTo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.terms.tiers.oneOf.0.items.[INDEX].upTo","typeLabel":"integer\u003cuint64> | null"},"unitPrice":{"type":"object","description":"Price per redemption in this tier.","properties":{"value":{"type":"integer","minimum":0,"maximum":100000000,"description":"Price in 1/10,000 euro.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.terms.tiers.oneOf.0.items.[INDEX].unitPrice.value","typeLabel":"integer"},"scale":{"type":"integer","const":4,"description":"Always 4.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.terms.tiers.oneOf.0.items.[INDEX].unitPrice.scale","typeLabel":"integer"}},"required":["value","scale","label"],"additionalProperties":false,"example":{"value":1250,"scale":4,"label":"0,1250 €"},"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.terms.tiers.oneOf.0.items.[INDEX].unitPrice","typeLabel":"object"}},"required":["upTo","unitPrice"],"additionalProperties":false,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.terms.tiers.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Tiers in order (`graduated`, 2-10 tiers); `null` for `per-unit`.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.terms.tiers.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"upTo":{"oneOf":[{"type":"integer","description":"Last redemption number (in the month) this tier covers; `null` on the last tier.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true},{"type":"null","description":"Last redemption number (in the month) this tier covers; `null` on the last tier."}]},"unitPrice":{"type":"object","description":"Price per redemption in this tier.","properties":{"value":{"type":"integer","minimum":0,"maximum":100000000,"description":"Price in 1/10,000 euro."},"scale":{"type":"integer","const":4,"description":"Always 4."}},"required":["value","scale","label"],"additionalProperties":false,"example":{"value":1250,"scale":4,"label":"0,1250 €"}}},"required":["upTo","unitPrice"],"additionalProperties":false},"description":"Tiers in order (`graduated`, 2-10 tiers); `null` for `per-unit`.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.terms.tiers.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.terms.tiers","typeLabel":"object[] | null"}},"required":["pricingModel","unitPrice","tiers"],"additionalProperties":false,"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.terms","typeLabel":"object"},"termsDigest":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"Lower-case hex SHA-256 of the canonical terms; send it back when you accept.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.termsDigest","typeLabel":"string"},"acceptBy":{"type":"string","format":"date-time","description":"Accept before this instant to keep redeeming without a pause (= `startsAt`).","example":"2026-11-01T00:00:00Z","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.acceptBy","typeLabel":"string\u003cdate-time>"},"acceptance":{"type":"object","properties":{"status":{"type":"string","enum":["accepted","pending","not-required"],"description":"Whether you accepted these terms. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.acceptance.status","typeLabel":"enum\u003cstring>"},"priceAcceptanceId":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"The acceptance (when accepted).","uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.acceptance.priceAcceptanceId","typeLabel":"integer\u003cuint64>"},"acceptedAt":{"type":"string","format":"date-time","description":"When accepted.","example":"2026-11-01T00:00:00Z","uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.acceptance.acceptedAt","typeLabel":"string\u003cdate-time>"},"acceptedBy":{"type":"object","description":"Who accepted.","properties":{"type":{"type":"string","enum":["partner-user","api-key","admin-user","system","end-customer"],"description":"Kind of actor. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.acceptance.acceptedBy.type","typeLabel":"enum\u003cstring>"},"id":{"oneOf":[{"type":"integer","description":"Id of the user or API key; `null` for AllRide staff and the system.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.acceptance.acceptedBy.id.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Id of the user or API key; `null` for AllRide staff and the system.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.acceptance.acceptedBy.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.acceptance.acceptedBy.id","typeLabel":"integer\u003cuint64> | null"},"label":{"type":"string","description":"Display label (email of the user, API key name, `AllRide`, `System`).","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.acceptance.acceptedBy.label","typeLabel":"string"}},"required":["type","id","label"],"additionalProperties":false,"example":{"type":"api-key","id":12017,"label":"Production integration"},"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.acceptance.acceptedBy","typeLabel":"object"}},"required":["status"],"additionalProperties":false,"description":"Your acceptance of this period.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0.acceptance","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.0","typeLabel":"object"},{"type":"null","description":"The period in force now; `null` when the set is not priced now.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].current","typeLabel":"object | null"},"upcoming":{"type":"array","items":{"type":"object","properties":{"startsAt":{"type":"string","format":"date-time","description":"Start of the period (UTC).","example":"2026-11-01T00:00:00Z","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].startsAt","typeLabel":"string\u003cdate-time>"},"endsAt":{"oneOf":[{"type":"string","description":"End of the period (exclusive); `null` when open-ended.","format":"date-time","example":"2026-11-01T00:00:00Z","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].endsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"End of the period (exclusive); `null` when open-ended.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].endsAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].endsAt","typeLabel":"string\u003cdate-time> | null"},"terms":{"type":"object","description":"The resolved Price Terms of the period.","properties":{"pricingModel":{"type":"string","enum":["per-unit","graduated"],"description":"`per-unit`: one unit price; `graduated`: tiers by the n-th redemption of the month. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].terms.pricingModel","typeLabel":"enum\u003cstring>"},"unitPrice":{"oneOf":[{"type":"object","description":"Price per redemption (`per-unit`); `null` for `graduated`.","required":["value","scale","label"],"example":{"value":1250,"scale":4},"properties":{"value":{"type":"integer","minimum":0,"maximum":100000000,"description":"Price in 1/10,000 euro.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].terms.unitPrice.oneOf.0.value","typeLabel":"integer"},"scale":{"type":"integer","const":4,"description":"Always 4.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].terms.unitPrice.oneOf.0.scale","typeLabel":"integer"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].terms.unitPrice.oneOf.0","typeLabel":"object"},{"type":"null","description":"Price per redemption (`per-unit`); `null` for `graduated`.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].terms.unitPrice.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].terms.unitPrice","typeLabel":"object | null"},"tiers":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"upTo":{"oneOf":[{"type":"integer","description":"Last redemption number (in the month) this tier covers; `null` on the last tier.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].terms.tiers.oneOf.0.items.[INDEX].upTo.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Last redemption number (in the month) this tier covers; `null` on the last tier.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].terms.tiers.oneOf.0.items.[INDEX].upTo.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].terms.tiers.oneOf.0.items.[INDEX].upTo","typeLabel":"integer\u003cuint64> | null"},"unitPrice":{"type":"object","description":"Price per redemption in this tier.","properties":{"value":{"type":"integer","minimum":0,"maximum":100000000,"description":"Price in 1/10,000 euro.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].terms.tiers.oneOf.0.items.[INDEX].unitPrice.value","typeLabel":"integer"},"scale":{"type":"integer","const":4,"description":"Always 4.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].terms.tiers.oneOf.0.items.[INDEX].unitPrice.scale","typeLabel":"integer"}},"required":["value","scale","label"],"additionalProperties":false,"example":{"value":1250,"scale":4,"label":"0,1250 €"},"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].terms.tiers.oneOf.0.items.[INDEX].unitPrice","typeLabel":"object"}},"required":["upTo","unitPrice"],"additionalProperties":false,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].terms.tiers.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Tiers in order (`graduated`, 2-10 tiers); `null` for `per-unit`.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].terms.tiers.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"upTo":{"oneOf":[{"type":"integer","description":"Last redemption number (in the month) this tier covers; `null` on the last tier.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true},{"type":"null","description":"Last redemption number (in the month) this tier covers; `null` on the last tier."}]},"unitPrice":{"type":"object","description":"Price per redemption in this tier.","properties":{"value":{"type":"integer","minimum":0,"maximum":100000000,"description":"Price in 1/10,000 euro."},"scale":{"type":"integer","const":4,"description":"Always 4."}},"required":["value","scale","label"],"additionalProperties":false,"example":{"value":1250,"scale":4,"label":"0,1250 €"}}},"required":["upTo","unitPrice"],"additionalProperties":false},"description":"Tiers in order (`graduated`, 2-10 tiers); `null` for `per-unit`.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].terms.tiers.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].terms.tiers","typeLabel":"object[] | null"}},"required":["pricingModel","unitPrice","tiers"],"additionalProperties":false,"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].terms","typeLabel":"object"},"termsDigest":{"type":"string","pattern":"^[0-9a-f]{64}$","description":"Lower-case hex SHA-256 of the canonical terms; send it back when you accept.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].termsDigest","typeLabel":"string"},"acceptBy":{"type":"string","format":"date-time","description":"Accept before this instant to keep redeeming without a pause (= `startsAt`).","example":"2026-11-01T00:00:00Z","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].acceptBy","typeLabel":"string\u003cdate-time>"},"acceptance":{"type":"object","properties":{"status":{"type":"string","enum":["accepted","pending","not-required"],"description":"Whether you accepted these terms. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].acceptance.status","typeLabel":"enum\u003cstring>"},"priceAcceptanceId":{"type":"integer","format":"uint64","minimum":0,"maximum":18446744073709552000,"x-bigint":true,"description":"The acceptance (when accepted).","uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].acceptance.priceAcceptanceId","typeLabel":"integer\u003cuint64>"},"acceptedAt":{"type":"string","format":"date-time","description":"When accepted.","example":"2026-11-01T00:00:00Z","uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].acceptance.acceptedAt","typeLabel":"string\u003cdate-time>"},"acceptedBy":{"type":"object","description":"Who accepted.","properties":{"type":{"type":"string","enum":["partner-user","api-key","admin-user","system","end-customer"],"description":"Kind of actor. Treat as an open set: new values may be added.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].acceptance.acceptedBy.type","typeLabel":"enum\u003cstring>"},"id":{"oneOf":[{"type":"integer","description":"Id of the user or API key; `null` for AllRide staff and the system.","format":"uint64","maximum":18446744073709552000,"minimum":0,"x-bigint":true,"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].acceptance.acceptedBy.id.oneOf.0","typeLabel":"integer\u003cuint64>"},{"type":"null","description":"Id of the user or API key; `null` for AllRide staff and the system.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].acceptance.acceptedBy.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].acceptance.acceptedBy.id","typeLabel":"integer\u003cuint64> | null"},"label":{"type":"string","description":"Display label (email of the user, API key name, `AllRide`, `System`).","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].acceptance.acceptedBy.label","typeLabel":"string"}},"required":["type","id","label"],"additionalProperties":false,"example":{"type":"api-key","id":12017,"label":"Production integration"},"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].acceptance.acceptedBy","typeLabel":"object"}},"required":["status"],"additionalProperties":false,"description":"Your acceptance of this period.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX].acceptance","typeLabel":"object"}},"required":["startsAt","endsAt","terms","termsDigest","acceptBy","acceptance"],"additionalProperties":false,"description":"A period during which your resolved Price Terms are constant.","uniqueKey":"payload.voucherSets.items.[INDEX].upcoming.items.[INDEX]","typeLabel":"object"},"maxItems":5,"description":"Up to 5 following periods in order.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX].upcoming","typeLabel":"object[]"},"_links":{"type":"object","description":"Related resources you may follow (HAL style). A link is present only when you hold the target's permissions.","properties":{"self":{"type":"object","description":"This resource.","properties":{"href":{"type":"string","format":"uri","description":"Absolute URL.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX]._links.self.href","typeLabel":"string\u003curi>"},"type":{"type":"string","description":"Media type of the target, usually `application/json`.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX]._links.self.type","typeLabel":"string"}},"required":["href","type"],"additionalProperties":false,"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX]._links.self","typeLabel":"object"},"voucherSet":{"type":"object","description":"The catalog voucher set.","properties":{"href":{"type":"string","format":"uri","description":"Absolute URL.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX]._links.voucherSet.href","typeLabel":"string\u003curi>"},"type":{"type":"string","description":"Media type of the target, usually `application/json`.","isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX]._links.voucherSet.type","typeLabel":"string"}},"required":["href","type"],"additionalProperties":false,"uniqueKey":"payload.voucherSets.items.[INDEX]._links.voucherSet","typeLabel":"object"}},"required":["self"],"additionalProperties":false,"isRequired":true,"uniqueKey":"payload.voucherSets.items.[INDEX]._links","typeLabel":"object"}},"required":["id","resource","voucherSetId","providerPartnerId","provider","voucherSetName","status","nextChangeAt","current","upcoming","_links"],"additionalProperties":false,"uniqueKey":"payload.voucherSets.items.[INDEX]","typeLabel":"object"},"description":"Your Price Terms of the affected voucher sets.","isRequired":true,"uniqueKey":"payload.voucherSets","typeLabel":"object[]"}},"required":["resource","id","startsAt","voucherSets"],"additionalProperties":false,"description":"The resource the event is about, starting with `resource` and `id`: the consumer view of the resource, or the fields this event type defines.","isRequired":true,"uniqueKey":"payload","typeLabel":"object"}},"required":["event","payload"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"event":{"id":"3f1c9a52-7b4e-4d21-9c6a-0e5d8b2f4a17","type":"price-terms-change-scheduled","timestamp":1793610900},"payload":{"resource":"price-change","id":7301,"startsAt":"2026-11-30T23:00:00Z","voucherSets":[{"id":2030,"resource":"voucher-set-price-terms","voucherSetId":2030,"providerPartnerId":1030,"provider":{"id":1030,"resource":"partner","name":"Acme Scooters","_links":{"self":{"href":"https://api.voucher.allride.io/consumer/v1/catalog/providers/1030","type":"application/json"}}},"voucherSetName":{"de":"Acme Starter Pass","en":"Acme Starter Pass"},"status":"change-pending","nextChangeAt":"2026-11-30T23:00:00Z","current":{"startsAt":"2025-12-31T23:00:00Z","endsAt":"2026-11-30T23:00:00Z","terms":{"pricingModel":"per-unit","unitPrice":{"value":800,"scale":4,"label":"€0.08"},"tiers":null},"termsDigest":"4f0c2a9e7b13d5c8e1f6a0b2c4d6e8f0a1b3c5d7e9f1a3b5c7d9e1f3a5b7c9d1","acceptBy":"2025-12-31T23:00:00Z","acceptance":{"status":"accepted","priceAcceptanceId":61017,"acceptedAt":"2026-01-03T09:12:00Z","acceptedBy":{"type":"partner-user","id":4069,"label":"[email protected]"}}},"upcoming":[{"startsAt":"2026-11-30T23:00:00Z","endsAt":null,"terms":{"pricingModel":"per-unit","unitPrice":{"value":1000,"scale":4,"label":"€0.10"},"tiers":null},"termsDigest":"9a17e3c5b7d9f1a3c5e7a9b1d3f5a7c9e1b3d5f7a9c1e3b5d7f9a1c3e5b7d9f1","acceptBy":"2026-11-30T23:00:00Z","acceptance":{"status":"pending"}}],"_links":{"self":{"href":"https://api.voucher.allride.io/consumer/v1/pricing/voucher-sets/2030","type":"application/json"},"voucherSet":{"href":"https://api.voucher.allride.io/consumer/v1/catalog/voucher-sets/2030","type":"application/json"}}}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"73ba463a-e941-498f-b42c-d45bf3b4394f":{"description":"Acknowledge receipt within 15 seconds.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"71ba7d99-332e-4a0e-be21-eb5a84f6a8d9":{"description":"Any other status, a redirect or a timeout is a failed attempt; Pub/Sub delivers the event again (at most 5 attempts in total).","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"e665e8eb-c733-4f11-acb6-1852122ca357":{"apiKey":{"type":"http","scheme":"bearer","bearerFormat":"vk_live_\u003ckeyId>_\u003csecret>","description":"Your API key in `Authorization: Bearer \u003ckey>`. Use `vk_test_…` keys against the sandbox and `vk_live_…` keys against production.","scopes":[],"schemeName":"apiKey"}}},"servers":{"194c8b4a-ee81-4799-8d91-168cc798538c":{"url":"https://api.voucher-staging.allride.io","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"vk_live_\u003ckeyId>_\u003csecret>","description":"Your API key in `Authorization: Bearer \u003ckey>`. Use `vk_test_…` keys against the sandbox and `vk_live_…` keys against production.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your API key in `Authorization: Bearer \u003ckey>`. Use `vk_test_…` keys against the sandbox and `vk_live_…` keys against production.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"openapi/consumer.v1.json"},"subdomain":"allride-voucher-consumer","siteName":"AllRide Vouchers — Consumer API","title":"price-terms-change-scheduled - AllRide Vouchers — Consumer API","navMaps":{"firstHrefInVersion":{"v1":{"href":"/webhooks/events/price-terms-change-scheduled","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-26T14:29:21.350Z","originalFileLocation":"webhooks/events/price-terms-change-scheduled.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=\"A price change was scheduled\">\u003cmeta data-mint-head name=\"application-name\" content=\"AllRide Vouchers — Consumer API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/allride-voucher-consumer/PLfxlSfQYmN0h3Xy/_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/allride-voucher-consumer/PLfxlSfQYmN0h3Xy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/allride-voucher-consumer/PLfxlSfQYmN0h3Xy/_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/allride-voucher-consumer/PLfxlSfQYmN0h3Xy/_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/allride-voucher-consumer/PLfxlSfQYmN0h3Xy/_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/allride-voucher-consumer/PLfxlSfQYmN0h3Xy/_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/allride-voucher-consumer/PLfxlSfQYmN0h3Xy/_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/allride-voucher-consumer/PLfxlSfQYmN0h3Xy/_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/allride-voucher-consumer/PLfxlSfQYmN0h3Xy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"price-terms-change-scheduled - AllRide Vouchers — Consumer API\">\u003cmeta data-mint-head property=\"og:description\" content=\"A price change was scheduled\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"AllRide Vouchers — Consumer API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://allride-voucher-consumer.mintlify.app/webhooks/events/price-terms-change-scheduled\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://allride-voucher-consumer.mintlify.app/_mintlify/api/og/v2?division=Price+terms\u0026amp;title=price-terms-change-scheduled\u0026amp;description=A+price+change+was+scheduled\u0026amp;theme=aa1e578c5c25daaa6c2c70a3\u0026amp;signature=201b9defab734586ede23b626f41fb057ab6e8cef3e523438d6daf4a239b8a05\">\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=\"price-terms-change-scheduled - AllRide Vouchers — Consumer API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"A price change was scheduled\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://allride-voucher-consumer.mintlify.app/_mintlify/api/og/v2?division=Price+terms\u0026amp;title=price-terms-change-scheduled\u0026amp;description=A+price+change+was+scheduled\u0026amp;theme=aa1e578c5c25daaa6c2c70a3\u0026amp;signature=201b9defab734586ede23b626f41fb057ab6e8cef3e523438d6daf4a239b8a05\">\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/allride-voucher-consumer/PLfxlSfQYmN0h3Xy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"AllRide Vouchers — Consumer API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0A0A0A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://allride-voucher-consumer.mintlify.app/webhooks/events/price-terms-change-scheduled\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/webhooks/events/price-terms-change-scheduled.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://allride-voucher-consumer.mintlify.app/#organization\",\"name\":\"AllRide Vouchers — Consumer API\",\"url\":\"https://allride-voucher-consumer.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/allride-voucher-consumer/9vqpJaAUcuaHTUy2/logo/light.svg?fit=max\u0026auto=format\u0026n=9vqpJaAUcuaHTUy2\u0026q=85\u0026s=92f0ea94edcefc1febba871b5ead8cdd\"}},{\"@type\":\"WebSite\",\"@id\":\"https://allride-voucher-consumer.mintlify.app#website\",\"name\":\"AllRide Vouchers — Consumer API\",\"url\":\"https://allride-voucher-consumer.mintlify.app\",\"publisher\":{\"@id\":\"https://allride-voucher-consumer.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://allride-voucher-consumer.mintlify.app/webhooks/events/price-terms-change-scheduled#webpage\",\"url\":\"https://allride-voucher-consumer.mintlify.app/webhooks/events/price-terms-change-scheduled\",\"name\":\"price-terms-change-scheduled\",\"description\":\"A price change was scheduled\",\"dateModified\":\"2026-10-26T14:29:21.350Z\",\"isPartOf\":{\"@id\":\"https://allride-voucher-consumer.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://allride-voucher-consumer.mintlify.app/webhooks/events/price-terms-change-scheduled#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://allride-voucher-consumer.mintlify.app/webhooks/events/price-terms-change-scheduled#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Price terms\",\"item\":\"https://allride-voucher-consumer.mintlify.app/webhooks/events/price-terms-acceptance-required\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"price-terms-change-scheduled\",\"item\":\"https://allride-voucher-consumer.mintlify.app/webhooks/events/price-terms-change-scheduled\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://allride-voucher-consumer.mintlify.app/webhooks/events/price-terms-change-scheduled#apireference\",\"headline\":\"price-terms-change-scheduled\",\"name\":\"price-terms-change-scheduled\",\"description\":\"A price change was scheduled\",\"url\":\"https://allride-voucher-consumer.mintlify.app/webhooks/events/price-terms-change-scheduled\",\"mainEntityOfPage\":{\"@id\":\"https://allride-voucher-consumer.mintlify.app/webhooks/events/price-terms-change-scheduled#webpage\"},\"dateModified\":\"2026-10-26T14:29:21.350Z\",\"publisher\":{\"@id\":\"https://allride-voucher-consumer.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://allride-voucher-consumer.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"AllRide Vouchers — Consumer API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"AllRide Vouchers — Consumer API","nav":{"global":null,"versions":[{"version":"v1","default":true,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","pages":[{"title":"API reference","href":"/api-reference/consumer-catalog-providers-list"}]},{"tab":"Webhook events","groups":[{"group":"Redemptions","pages":[{"title":"redemption-created","openapi":"openapi/consumer.v1.json webhook redemption-created","href":"/webhooks/events/redemption-created"},{"title":"redemption-voided","openapi":"openapi/consumer.v1.json webhook redemption-voided","href":"/webhooks/events/redemption-voided"}]},{"group":"Redemption entities","pages":[{"title":"redemption-entity-created","openapi":"openapi/consumer.v1.json webhook redemption-entity-created","href":"/webhooks/events/redemption-entity-created"}]},{"group":"Redemption links","pages":[{"title":"redemption-link-exhausted","openapi":"openapi/consumer.v1.json webhook redemption-link-exhausted","href":"/webhooks/events/redemption-link-exhausted"},{"title":"redemption-link-expired","openapi":"openapi/consumer.v1.json webhook redemption-link-expired","href":"/webhooks/events/redemption-link-expired"}]},{"group":"Catalog","pages":[{"title":"catalog-voucher-set-activated","openapi":"openapi/consumer.v1.json webhook catalog-voucher-set-activated","href":"/webhooks/events/catalog-voucher-set-activated"},{"title":"catalog-voucher-set-activation-scheduled","openapi":"openapi/consumer.v1.json webhook catalog-voucher-set-activation-scheduled","href":"/webhooks/events/catalog-voucher-set-activation-scheduled"},{"title":"catalog-voucher-set-available","openapi":"openapi/consumer.v1.json webhook catalog-voucher-set-available","href":"/webhooks/events/catalog-voucher-set-available"},{"title":"catalog-voucher-set-deactivated","openapi":"openapi/consumer.v1.json webhook catalog-voucher-set-deactivated","href":"/webhooks/events/catalog-voucher-set-deactivated"},{"title":"catalog-voucher-set-deactivation-scheduled","openapi":"openapi/consumer.v1.json webhook catalog-voucher-set-deactivation-scheduled","href":"/webhooks/events/catalog-voucher-set-deactivation-scheduled"},{"title":"catalog-voucher-set-depleted","openapi":"openapi/consumer.v1.json webhook catalog-voucher-set-depleted","href":"/webhooks/events/catalog-voucher-set-depleted"},{"title":"catalog-voucher-set-stock-low","openapi":"openapi/consumer.v1.json webhook catalog-voucher-set-stock-low","href":"/webhooks/events/catalog-voucher-set-stock-low"},{"title":"catalog-voucher-set-unavailable","openapi":"openapi/consumer.v1.json webhook catalog-voucher-set-unavailable","href":"/webhooks/events/catalog-voucher-set-unavailable"},{"title":"catalog-voucher-set-updated","openapi":"openapi/consumer.v1.json webhook catalog-voucher-set-updated","href":"/webhooks/events/catalog-voucher-set-updated"}]},{"group":"Price terms","pages":[{"title":"price-terms-acceptance-required","openapi":"openapi/consumer.v1.json webhook price-terms-acceptance-required","href":"/webhooks/events/price-terms-acceptance-required"},{"title":"price-terms-accepted","description":"Price Terms were accepted","openapi":"openapi/consumer.v1.json webhook price-terms-accepted","href":"/webhooks/events/price-terms-accepted"},{"title":"price-terms-change-scheduled","openapi":"openapi/consumer.v1.json webhook price-terms-change-scheduled","href":"/webhooks/events/price-terms-change-scheduled"}]},{"group":"Invoices","pages":[{"title":"invoice-finalised","description":"An invoice was issued","openapi":"openapi/consumer.v1.json webhook invoice-finalised","href":"/webhooks/events/invoice-finalised"},{"title":"invoice-overdue","openapi":"openapi/consumer.v1.json webhook invoice-overdue","href":"/webhooks/events/invoice-overdue"},{"title":"invoice-paid","openapi":"openapi/consumer.v1.json webhook invoice-paid","href":"/webhooks/events/invoice-paid"},{"title":"invoice-voided","openapi":"openapi/consumer.v1.json webhook invoice-voided","href":"/webhooks/events/invoice-voided"}]},{"group":"Payments","pages":[{"title":"payment-failed","openapi":"openapi/consumer.v1.json webhook payment-failed","href":"/webhooks/events/payment-failed"}]},{"group":"Payment methods","pages":[{"title":"payment-method-deactivated","openapi":"openapi/consumer.v1.json webhook payment-method-deactivated","href":"/webhooks/events/payment-method-deactivated"}]},{"group":"Webhook endpoints","pages":[{"title":"webhook-endpoint-test","openapi":"openapi/consumer.v1.json webhook webhook-endpoint-test","href":"/webhooks/events/webhook-endpoint-test"}]}]}]}]},"basePath":"","title":"price-terms-change-scheduled - AllRide Vouchers — Consumer API","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}